Send a test webhook
test_site_webhook
Sends a publish.succeeded test payload to one webhook endpoint so you can confirm it is wired up.
It makes a real outbound call to your endpoint, with the webhook's own URL, payload type and signing secret. It fires even when the webhook is switched off or does not subscribe to publish.succeeded.
The call succeeds whether or not the endpoint accepted it. It returns delivered, the response status and any error, so read those rather than treating success as proof the endpoint is healthy. The message reads Test event delivered successfully. or Test event sent, but the endpoint did not accept it.
Every test is recorded in the delivery log, failed or not, and a failed test is never retried. Tests do not count toward the webhook's sent and failed totals or toward switching it off automatically. See Webhooks.
Inputs
| Input | Type | Required | Description |
|---|---|---|---|
projectId |
string | Yes | The site id. |
webhookId |
string | Yes | The webhook to test, by its id from list_site_webhooks. |