Skip to main content
POST
Trigger Webhook Event

Authorizations

x-api-key
string
header
required

API key for authentication. Must be included in the x-api-key header.

Path Parameters

webhook_id
string<uuid>
required

The unique identifier of the webhook event to trigger

Response

Webhook triggered successfully

id
string<uuid>

The webhook event ID that was triggered

Example:

"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"

trigger_status
enum<string>

Status of the webhook trigger attempt

Available options:
success,
failed
Example:

"success"

triggered_at
string<date-time>

Timestamp when the webhook was triggered

Example:

"YYYY-MM-DDTHH:MM:SS.sssZ"

message
string

Status message for the trigger attempt

Example:

"Webhook triggered successfully"