Trigger a playbook via webhook

View as Markdown

Public endpoint. External callers (no WorkOS JWT) authenticate via a per-playbook HMAC secret in X-Webhook-Secret and supply an X-Idempotency-Key. Creates (or replays) a playbook run for the targeted project. Idempotency is exactly-once across retries and concurrent deliveries.

Path parameters

orgSlugstringRequired
playbookSlugstringRequired

Headers

X-Webhook-SecretstringRequired

Per-playbook HMAC secret authenticating the caller.

X-Idempotency-KeystringRequired

Caller-supplied key making delivery exactly-once across retries.

Response

Replayed delivery — the run already exists.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
413
Content Too Large Error
422
Unprocessable Entity Error
500
Internal Server Error