Skip to main content

​
Overview

Destination 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.
postscript-1

2. Create the Converge Destination

  1. In the Converge sidebar, click on
    Event streams
    and then click Create new Destination.
  2. Select the Postscript destination and click Next.
  3. Give your destination a name (e.g. Postscript Destination) and click Next.
  4. Fill in the Private API Key you copied from Postscript and click Next.
  5. Select Use default mapping and click Next.
You can find the Default mapping for the Postscript destination here. For more information on setting up Custom mappings, look here.
  1. Select the sources you want to forward events from, then click Next.
This is a server-side destination, meaning that only server-side sources can be used with this destination. You can still select client-side sources but the events will not be sent to Postscript.
  1. Review any issues and click Submit.
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 destination 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.
See the original Viewed Product spec here
cvg({
  method: "track",
  eventName: "Viewed Product",
  properties: {
    product_id: "123456",
    variant_id: "78910", 
    sku: "MY_SKU",
    name: "My Product",
    variant_name: "Vanilla", 
    price: 42,
    currency: "USD",
    vendor: "My Store",
    url: "https://mystore.com/this-product", // This is new
    image_url: "https://mystore.com/assets/product.png" // This is new
  },
});
See the original Added To Cart spec here
cvg({
  method: "track",
  eventName: "Added To Cart",
  properties: {
    product_id: "123456",
    variant_id: "78910",
    sku: "MY_SKU",
    name: "My Product",
    variant_name: "Vanilla",
    price: 42,
    currency: "USD",
    quantity: 1,
    vendor: "My Store",
    url: "https://mystore.com/this-product", // This is new
    image_url: "https://mystore.com/assets/product.png" // This is new
  },
});
See the original Removed From Cart spec here
cvg({
  method: "track",
  eventName: "Removed From Cart",
  properties: {
    product_id: "123456",
    variant_id: "78910",
    sku: "MY_SKU",
    name: "My Product",
    variant_name: "Vanilla",
    price: 42,
    currency: "USD",
    quantity: 1,
    vendor: "My Store",
    url: "https://mystore.com/this-product", // This is new
    image_url: "https://mystore.com/assets/product.png" // This is new
  },
});

​
Event mapping

Converge automatically maps the following events from the Converge event spec to the Postscript spec.
Converge Event NamePostscript Event Name
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:
Postscript PropertyConverge Property
namename
price_in_centsprice converted to cents
resource_idproduct_id
resource_typeFixed to "product"
skusku
variant_namevariant_name
variant_idvariant_id
vendorvendor
currencycurrency
urlurl
image_urlimage_url
Postscript PropertyConverge Property
namename
price_in_centsprice
resource_idproduct_id
resource_typeFixed to "product"
skusku
variant_namevariant_name
variant_idvariant_id
vendorvendor
currencycurrency
urlurl
image_urlimage_url
quantityquantity
Postscript PropertyConverge Property
item_namesname for each item
item_vendorsvendor for each item
couponcoupon (separated by ,)
total_value_in_centstotal_price converted to cents
discount_value_in_centstotal_discount converted to cents
tax_value_in_centstotal_tax converted to cents
shipping_value_in_centstotal_shipping converted to cents
currencycurrency
itemslist of items (same mapping as Converge - add_to_cart)
Postscript PropertyConverge Property
categoryname
category_idid
image_urlimage_url
quantityquantity
Postscript PropertyConverge Property
order_idevent_id
item_namesname for each item
item_vendorsvendor for each item
couponcoupon (separated by ,)
total_value_in_centstotal_price converted to cents
discount_value_in_centstotal_discount converted to cents
tax_value_in_centstotal_tax converted to cents
shipping_value_in_centstotal_shipping converted to cents
currencycurrency
itemslist of items (same mapping as Converge - add_to_cart)
⌘I