For the complete documentation index, see llms.txt. This page is also available as Markdown.

Postscript

CheckoutChamp’s Integration to Postscript will allow you to create subscribers tied to Keywords in Postscript and to trigger pre-configured Postscript Automations to re-engage these subscribers.


Step 1: Obtain Postscript API Credentials

Click your store name in the top right corner, then click “API”

Once on the Account Page, click “Show” to uncover your Postscript Private Key

Be sure to save/copy the private key as this it is required for the CRM setup.

Step 2: Setup the CRM Plugin

Navigate to Admin → Plugins → Email Service Providers. Click the Postscript tile and then the +Activate button.

privateKey - enter the Postscript Private API Key saved from the first step.

enable useV2Api

Press Connect

Once the plugin is activated you should see Automation Triggers added in your Postscript account. These triggers will be used in both Postscript and CRM configuration.

The events are

  • Charge_Failed

  • Order_Cancelled

  • Order_Created

  • Order_Declined

  • Subscription_Cancelled

  • Subscription_Started

  • Subscription_Upcoming_Charge

Below are the available fields that can be used when forming the messages tied to the Postscript Automation Triggers.

Tag
Value

{client_orderid}

OrderId as displayed inside of CheckoutChamp

{first_name}

Customer’s first name

{last_name}

Customer’s last name

{email_address}

Customer’s email address

{phone_number}

Customer’s phone number

{shop_name}

Shop Name

{shop_link}

Shop Link

{sales_url}

A link back to the abandoned page (only available on Checkout_Started event)

Please contact your account manager if additional tags are needed.

Step 3: Plugin Routing Configuration

Navigate to Admin → Plugins → Email Service Providers. Click the Edit button on the activated Postscript tile.

On Advanced Setup, click the green “+” button to configure the Postscript campaign routes.

Step 4: Create Marketing Opt-in Checkbox in Checkout Champ

Creating a Marketing Opt-in Checkbox

Step 5: Setup Complete

Talk with your Account Manager to ensure your company is added to the PostScript task schedule.

At this point your Postscript plugin is fully configured and subscribers will be added to your shop after the order record has been created in our system.

Last updated