v4

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-15152735.4 KB
webhooks
trigger

triggers a webhook event either async or sync

Trigger a webhook

post/v1/webhooks/configs/{configId}/trigger

Path parameters

configIdstring required

Short uuid to identify the webhook configuration.

Query parameters

syncboolean

If set to true, the webhook will be triggered synchronously. Otherwise, it will be triggered asynchronously.

Request body

Example request

{
  "metadata": {
    "action": "Manual triggered by user with id 123456"
  }
}

Response

Success - if the webhook is triggered successfully

status_codestring
messagestring
bodyobject
codestring
status'succeeded' | 'failed'
start_datestring
end_datestring
event_idstring required