Skip to main content
Version: v1.2.1

Create a webhook test

Create a webhook test

POST 

/webhooks/test

Create a webhook test

  • This endpoint allows you to create a test webhook to simulate and validate how events, payloads, and their associated data are structured and transmitted when an event is triggered.
  • It helps ensure the webhook configuration meets your requirements before using it in production.

Body

  • The body property is an optional string that uses the 'mustache' template syntax. If provided, it will be used to format the webhook payload according to the specified template. For example, when integrating with Microsoft Teams, the body must follow the structure required by Teams' webhook format. If the body property is not provided, the webhook will send the full event data as a JSON object.
  • When using the body property, only the following data fields are supported for interpolation:
    • {{id}}: The unique identifier of the event.
    • {{name}}: The name associated with the event.
    • {{event}}: The type of event being triggered.
    • {{date}}: The date and time when the event occurred.

Headers

  • Authorization: Optional. If provided, it will be included in the webhook request headers
  • X-Custom-Header: Optional. If provided, it will be included in the webhook request headers

Request

Responses

Webhook created successfully