v29

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-13511526891.2 KB
Webhooks

Test Webhook

Tests a new or existing webhook.

When testing an existing webhook, the existing webhook data will be attached automatically as part of the outbound test request. The data includes the request format, http method, authentication method (only if same type and add_position are attached), and signing secret. The request payload data will overwrite existing webhook data in the outbound test request.

post/api/v2/webhooks/test

Query parameters

webhook_idstring

The webhook to be tested. Only required for testing an existing webhook.

Request body

Response

Test completed successfully