Receiving Events

Subscribing to Event Types

To use the Events API, start by configuring the Export API step in the workflow builder.

Your Callback URL(s) will receive JSON payloads for the event types you subscribe to. The number of events will depend on user activity within your workflow. Each event generates one request to a Callback URL.


Notes
Webhook events are queued and delivered in sequence. During periods of high traffic, there may be a delay before events are sent, so delivery may not occur immediately after the corresponding actions in Workflow Studio.
You cannot subscribe to events through our API. Use the workflow builder to subscribe to webhooks via the Export API step.

URL Verification Handshake

Events sent to a Request URL may contain sensitive data from your workflow. To ensure secure delivery, we verify your server ownership with a challenge request. After you configure the API Export node and add a Request URL, we will send an HTTP POST request to that URL. This request will verify your SSL certificate and include a JSON body with three fields.

Refer to URL verification handshake below for further details.


Query Params
string
required

The URL to dispatch events to

Response
200

OK

Callbacks
Language
LoadingLoading…
Click Try It! to start a request and see the response here!