DocsNodesStarts the workflowWebhook received

Webhook received

Starts a run when something outside WBSKT posts to the workflow's own URL: a form, another service, a script or a button on your phone. The request body becomes the run's input.

Kindtrigger:webhook
GroupStarts the workflow
CreditsFree
Ports out1

How it looks

Settings

SettingRequiredWhat it does
PathpathYesThe last part of the URL, like doorbell. The console shows the full URL to copy.
SecretsecretNoOptional, but set one. Callers send it in the X-Wbskt-Secret header. It's stored hashed, and a wrong secret gets the same answer as a right one, so it can't be guessed by trying.
Only whenfilterNoConditions on the body. A call that doesn't match starts no run and costs nothing.
If it fires while a run is still goingconcurrencyPolicyNoQueue by default. See Runs that overlap below.
Correlation keycorrelationKeyNoWhich runs count as the same for the setting above. Left empty, the path. Set it to share one line with another trigger.

Ports

PortThe run leaves by it when
defaultA call matched and started a run.

What it adds to the run

Later nodes can read these, in a condition or as {{name}} in a text field.

ValueHolds
triggerThe request body. A JSON body's fields can be read in later nodes, like {{trigger.payload.button}}.
triggeredAtWhen the trigger fired.

Example

call it
curl -X POST https://api.dev.wbskt.com/api/callbacks/webhook/<workspace>/doorbell \
  -H "Content-Type: application/json" \
  -H "X-Wbskt-Secret: <your secret>" \
  -H "Idempotency-Key: ring-0142" \
  -d '{ "button": "front" }'
Retries are safeSend an Idempotency-Key header and a retry with the same key within 24 hours starts nothing new. Only POST is accepted.

Runs that overlap

What happens when the trigger fires again while a run with the same correlation key is still going.

SettingWhat happens
QueuedefaultThe new event waits. When the run finishes, the oldest waiting event starts the next one. Events wait up to 24 hours.
Allow parallelAnother run starts alongside.
Drop if runningThe new event is dropped.
Cancel existingThe running one is cancelled and a new one starts.

Problems you might see

CodeMeans
IDEMPOTENCY_KEY_INVALIDThe Idempotency-Key header isn't 1–255 printable characters. Answered with 400.

Problems found when you publish stop the publish and point at the node. Problems while a run is going fail the node, and its On failure setting decides what happens next. See the error codes for the API's own.