GET /accounts/{account_id}/workflows/{workflow_name}/instances/{instance_id}/subscribe

Opens a WebSocket that streams workflow instance events.

Servers

Path parameters

Name Type Required Description
instance_id String Yes
account_id String Yes
workflow_name String Yes

Query parameters

Name Type Required Description
filter String No

Comma-separated workflow event types to include.

cursor Integer No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.