Skip to main content

Postscript integration

Swym-Postscript Integration

Updated over a week ago

The Swym-Postscript integration allows you to collect SMS subscriptions for back-in-stock alerts and send automated SMS notifications to subscribers when products are restocked.

Prerequisites

  • Swym Starter plan or above.

  • An active Postscript plan.

Configuration Steps

  • Part 1: Enable Back-in-Stock Alert Event in Swym

    1. Navigate to the Swym Admin panel.

    2. Enable the Back In Stock email trigger if you haven't already.

  • Part 2: Enable Back-in-Stock SMS Alerts in Swym

    1. In Swym Admin, go to Swym Back in Stock Alerts and click "Manage".

    2. Select Postscript as the SMS provider and click "Configure".

    3. In your Postscript account, go to Settings > API and create a new Private API Key. Add a descriptive label.

    4. Copy the new Private API Key and paste it into the corresponding field in Swym Admin, then click "Save Configurations".

    5. In Postscript, create a new Keyword specifically for Swym back-in-stock campaigns.

    6. Back in Swym Admin, scroll to the Keywords section, click the dropdown, and select the keyword you just created. Click "Save".

    7. In the Countries section, select the countries you wish to market to and click "Save List". Ensure these countries are supported in your Postscript account.

    8. Scroll to the Events section and select the back-in-stock event triggers you want to enable.

    9. Scroll back to the top and click the "Enable" button on the top right.

    10. A prompt will appear; click on "BiS SMS Alerts".

    11. On the settings page, scroll down to the Appearance section.

    12. Add the links to your Terms of Service and Privacy Policy.

    13. Optionally, click "Customize Appearance" to match the form to your store's design.

    14. Click "Save".

    15. Scroll back to the top and click the "Enable" button again. Your integration status should now show as "enabled".

  • Part 3: Create Postscript Automations

    1. In your Postscript account, navigate to Messaging > Automations > Legacy Automations.

    2. Click "Create Automation" and select "Create Legacy Automation".

    3. Choose the "Custom Automation" template.

    4. Select the appropriate automation trigger that you enabled in Swym Admin.

    5. Click "Save & Continue to Messages".

    6. Set the wait time (usually to 0) and customize the SMS message template.

    7. Click "Save Automation" to enable it.

Event Data

The following data elements are included with each event sent to Postscript.

  • Product Name

    • Element Label: product_name

    • Example: Navy Peaks Hoodie

    • Comment: –

  • Quantity*

    • Element Label: product_quantity

    • Example: 5

    • Comment: Inventory quantity available

  • Variant Info

    • Element Label: variant_info

    • Example: Blue

    • Comment: –

  • Product URL

    • Element Label: product_url

    • Example: https://example.com/products/hoodie

    • Comment: –

      *Quantity is not included for the "Swym Back in Stock Subscription" event.

Did this answer your question?