Webhooks
Workflow engine webhook ingress
Generic webhook ingress for WorkflowEngine WebhookTrigger nodes. Auth is JWT or User API key in the Authorization: Bearer <token> header. The API key is a user-level key, resolved against the User record and scoped to that user's organization. It is not a per-workflow secret, even though it is surfaced in the workflow builder next to the webhook id. The body must include a webhookId string that matches one or more WebhookTrigger.data.webhookId values for workflows in the caller's organization; everything else in the body is forwarded verbatim as the trigger node's payload output, so the body is flat and there is no nested payload key to send. The api validates auth, evaluates matching triggers, and enqueues one BullMQ job per match (workflows themselves execute on the workflow-runner service). Returns 202 with the matchedCount so the caller can tell whether any workflow was actually queued.
Authorization
bearerAuth In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
webhookId is required and must match a WebhookTrigger.data.webhookId on at least one workflow in the caller's org. Every other property is forwarded verbatim as the trigger node's payload output.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/webhook/workflow" \ -H "Content-Type: application/json" \ -d '{ "webhookId": "wh_64d2f9c5e8a1d4e001a0b1c3", "source": "zillow", "lead": { "name": "Alex Nguyen", "email": "alex.nguyen@example.com", "phone": "+14155551234" } }'{ "success": true, "message": "Webhook accepted", "data": { "webhookId": "wh_64d2f9c5e8a1d4e001a0b1c3", "matchedCount": 2 }}