Overview

Connection Type:

Server-side


Installation Instructions

1. Create a Postscript API key

  1. In your Postscript dashboard, select your Shop Name and navigate to API.
  2. Click on Create Security Key Pair and confirm by selecting Yes.
  3. Click in Add a label and use a label that helps you identify the API key (e.g. Converge).
  4. Under Private Key, click on Show and to copy the Private Key.

2. Create the Converge Connection

  1. Create and copy a Postscript API key from the Postscript dashboard.
  2. In Converge, click Create a new connection under the Connections tab. Select the Postscript app and paste the private Postscript API key.
  3. Give your connection a name and click on Create Connection.
If you are migrating from a previous Postscript to a Converge integration, make sure to modify your Flows to use the Converge Event Names and Event Properties here

Converge functionality

This integration supports the following Converge connection functionality.

Converge FeatureSupported
Custom Events
Filters
Server-side Conversions

Adding product URL and image URL to Converge events to power Postscript flows

A common use case of the Postscript Destination is to build Postscript SMS Flows based on Converge Events. As such, you might want to include a Product URL or Product Image URL in the Converge Event so you can leverage these in your flows.

To that end, you will want to extend the Converge Event Spec for the following events. Once you add the custom properties to your events, Converge will automatically forward these to the Postscript Destination.

Find code examples below that illustrate where you should add the Product URL and Product Image URL custom event properties.

Event Mapping

Converge automatically maps the following events from the Converge Event Spec to the Postscript spec.

Converge Event NamePostscript Event Name
$page_loadConverge - page_view
Viewed ProductConverge - viewed_product
Added To CartConverge - add_to_cart
Started CheckoutConverge - initiate_checkout
Viewed CollectionConverge - viewed_collection
Placed OrderConverge - purchase

You can find the property mapping for each event below: