Listen Workflow Trigger

Wait for a call to a Webhook trigger in the workflow's draft: send a request to the trigger's URL while this waits. The first call that arrives after it starts is saved as the trigger's sample output, so the steps can reference its query, body and headers, and answered with status received. With none in 30 seconds it answers status noCall: listen again. Every call to the URL is recorded, published or not; only calls during a listen become the sample.

POST

Path

Path parameters

stringrequired

The workflow's id, from List Workflows.

stringrequired

The trigger's id, from List Workflow Triggers.

Headers

Optional headers

string

Optional. The id of a child organization of your API key's company to act on. Leave it out to act on the key's own company. See Child organizations.

Response fields

statusstring

received: a call came in and is now the sample. noCall: none came within 30 seconds; listen again.

received
noCall

receivedOndate

When the call came in. Null for noCall.

outputobject

The call as the trigger answers it, now its sample output: [{ query, body, params, url, method, headers }]. Null for noCall.

outputFieldsarray of objects

The fields of the trigger's output, learned from its sample and offered to the steps.

keystring
The field's path in each record: dotted, with [] marking an array (lines[].sku). Reference it as {{ steps.<stepId>.output[0].<key> }}.
typestring
Its type as seen in the sample: string, number, boolean, object, date, a type with [] for an array, or mixed.

revisionstring

The draft's revision: send it in If-Match on your next change to the draft.