Receive Webhook

POST

/api/v1/webhooks/{webhook_key}

• API de Produção

Receive a webhook and trigger the associated workflow.

This is a PUBLIC endpoint - no authentication required.

The webhook payload is passed to the workflow as trigger_data.

Headers (optional):

• x-webhook-signature: HMAC-SHA256 signature of the payload
• x-hub-signature-256: GitHub-style signature (sha256=…)

Rate Limit: 60 requests per minute per webhook

Example payload:

{
    "event": "order.created",
    "data": {
        "order_id": 123,
        "customer_email": "cliente@example.com"
    }
}

Returns:

• success: Whether the workflow was triggered
• execution_id: ID of the workflow execution
• workflow_id: ID of the triggered workflow
• status: Execution status (pending, running, completed, failed)

Parameters

Path Parameters

webhook_key

required

Webhook Key

string

Responses

200

Successful Response

WebhookResponse

Response for webhook trigger

object

success

required

Success

boolean

execution_id

Any of:

integer

integer

null

null

workflow_id

Any of:

integer

integer

null

null

workflow_name

Any of:

string

string

null

null

status

Any of:

string

string

null

null

error

Any of:

string

string

null

null

message

Any of:

string

string

null

null

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string