Queues a synthetic test event to your configured webhook endpoint so you can confirm the endpoint is reachable and that your signature verification is working. If no signing secret has been configured yet, one is generated automatically before the test event is queued. Returns the queued event's event_id and event_type.

Authentication & access

• Requires a client API token: Authorization: Bearer <token>.
• The caller must hold the webhooks.test.send permission and have the OWNER or DEVELOPER role.
• When called with a dashboard account token, the request must carry a valid dashboard account context, otherwise it returns 403.

Preconditions & side effects

• A webhook endpoint (webhook_url) must be configured for your client. If it is not set, the request returns 400.
• If your client has no signing secret yet, one is generated automatically as part of this call so the test delivery can be signed.
• A test event of type webhook.test is queued for asynchronous delivery to your endpoint. The event payload includes a fixed test message.
• The action is recorded in your client-visible audit log.

Response

200 with a WebhookTestResponse:

The event is queued, not delivered synchronously. Use the deliveries log to inspect the outcome of the delivery attempt.

Error responses

Standard 401 (authentication), 403 (insufficient permission or role), and 429 (rate limit) responses apply to every endpoint and are documented in the Error reference.