Incoming Webhook Step

Triggers or listens to external webhooks as part of a workflow. Use this step to either send an outbound request or enable a listening mode to accept inbound callbacks and map incoming fields.

Top-level properties

nametyperequiredconstraints
authenticationTypestringyesenum: NONE, PAT
methodstringyesenum: GET, POST
listeningModeEnabledbooleanyesdefault: false
requestPayloadstringyesdefault: empty string
mappableFieldsarray[ExtractedField]yesdefault: empty array

ExtractedField

nametyperequired
keystringyes
labelstringyes
typestringyes
exampleValuestringno

Notes

  • authenticationType controls how the webhook is authenticated. PAT indicates a Personal Access Token model.
  • listeningModeEnabled toggles whether the step consumes inbound webhooks and exposes mappableFields for downstream mapping.
  • requestPayload applies to outbound requests, typically used with POST.
  • mappableFields describe fields extracted from webhook payloads that can be mapped in later steps.

Minimal example (JSON)

{
  "authenticationType": "NONE",
  "method": "GET",
  "listeningModeEnabled": false,
  "requestPayload": "",
  "mappableFields": []
}

Full example (JSON)

{
  "authenticationType": "PAT",
  "method": "POST",
  "listeningModeEnabled": true,
  "requestPayload": "{\"event\":\"workflow_started\",\"id\":\"abc-123\"}",
  "mappableFields": [
    { "key": "event", "label": "Event Type", "type": "string", "exampleValue": "workflow_started" },
    { "key": "id", "label": "Event ID", "type": "string", "exampleValue": "abc-123" },
    { "key": "createdAt", "label": "Created At", "type": "datetime" }
  ]
}