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.
trigger:webhookHow it looks
Settings
| Setting | Required | What it does |
|---|---|---|
| Pathpath | Yes | The last part of the URL, like doorbell. The console shows the full URL to copy. |
| Secretsecret | No | Optional, 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 whenfilter | No | Conditions on the body. A call that doesn't match starts no run and costs nothing. |
| If it fires while a run is still goingconcurrencyPolicy | No | Queue by default. See Runs that overlap below. |
| Correlation keycorrelationKey | No | Which runs count as the same for the setting above. Left empty, the path. Set it to share one line with another trigger. |
Ports
| Port | The run leaves by it when |
|---|---|
default | A 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.
| Value | Holds |
|---|---|
trigger | The request body. A JSON body's fields can be read in later nodes, like {{trigger.payload.button}}. |
triggeredAt | When the trigger fired. |
Example
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" }'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.
| Setting | What happens |
|---|---|
| Queuedefault | The new event waits. When the run finishes, the oldest waiting event starts the next one. Events wait up to 24 hours. |
| Allow parallel | Another run starts alongside. |
| Drop if running | The new event is dropped. |
| Cancel existing | The running one is cancelled and a new one starts. |
Problems you might see
| Code | Means |
|---|---|
IDEMPOTENCY_KEY_INVALID | The 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.
See also
Parks the run on a one-off callback URL until something calls it, or the time runs out.
Outdefaulttimeoutcontrol:waitForHttpCalls any HTTP endpoint, with an HTTP auth integration if it needs one. Errors leave by error.
Outdefaulterroraction:webhookChecks a condition, or several joined with and or or, and leaves by true or false.
Outtruefalsecontrol:logic