Send a Custom Event to use in Flows

Custom Events can be used as Flow Triggers or in Flow Wait for Event Split Branching Actions.

Type & Display Name

Events sent through the API will display the type prefixed with the partner/shop name in Flows. For example, if sending an event called "OrderPlaced", the event will display as as "[Your Partner/Shop Name] - OrderPlaced" to distinguish it from other events of a similar type.

Subscriber Identifiers

Events can include an identifier to tie the record to a subscriber (subscriber_id, phone, and/or email). API requests can be sent with multiple identifiers.

If provided, Postscript will attempt to reconcile the provided identifier(s) to a single Subscriber using the following steps:

  1. Attempt to match Subscriber usingsubscriber_id(unique across platform)
  2. If subscriber_id is not provided or no Subscriber has yet been matched, attempt to match using phone_number (unique per-Shop)
  3. If subscriber_id and phone are not provided or no Subscriber has yet been matched, attempt to match using email (if multiple Subscribers exist, prioritize the most recent opted-in Subscriber)

Matching is done asynchronously. If no Subscriber is found for the given identifier(s), the event definition will still be captured and made available in Flows.

Note: This recent update now means you may populate Postscript with your custom events prior to Subscribers triggering them.

Language
Authorization
Header
Click Try It! to start a request and see the response here!