Sign in

v4

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

getWebhookExample

Generate an example payload for a webhook configuration based on trigger type

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

Path parameters

configIdstring required

Short uuid to identify the webhook configuration.

Request body

automation_idstring

ID of the automation, if applicable

Example request

{
  "automation_id": "automation_123"
}

Response

Success - example payload generated

entityobject

Example payload for the webhook event

relationsobject[]

Example relations for the webhook event

Example response

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