Skip to content

Send test webhook

Send a test webhook to verify your endpoint is configured correctly. The test payload includes event: "webhook.test" to distinguish it from real events.

POST /v1/webhooks/test

Send a test webhook to verify your endpoint is configured correctly. The test payload includes event: "webhook.test" to distinguish it from real events.

Request body

Content-Type: application/json

  • webhookId (string) required — ID of the webhook to test

Example:

json

{
  "webhookId": "507f1f77bcf86cd799439011"
}

Responses

200 — Test webhook sent successfully

  • success (boolean)
  • message (string)

400 — Webhook ID required

401

500 — Test webhook failed to deliver

  • success (boolean)
  • message (string)