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
| name | type | required | constraints |
|---|---|---|---|
authenticationType | string | yes | enum: NONE, PAT |
method | string | yes | enum: GET, POST |
listeningModeEnabled | boolean | yes | default: false |
requestPayload | string | yes | default: empty string |
mappableFields | array[ExtractedField] | yes | default: empty array |
ExtractedField
| name | type | required |
|---|---|---|
key | string | yes |
label | string | yes |
type | string | yes |
exampleValue | string | no |
Notes
authenticationTypecontrols how the webhook is authenticated.PATindicates a Personal Access Token model.listeningModeEnabledtoggles whether the step consumes inbound webhooks and exposesmappableFieldsfor downstream mapping.requestPayloadapplies to outbound requests, typically used withPOST.mappableFieldsdescribe 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" }
]
}Updated 22 days ago
