Skip to main content
POST
/
v1
/
webhooks
/
test-delivery
Send test delivery
curl --request POST \
  --url https://api.example.com/v1/webhooks/test-delivery \
  --header 'Content-Type: application/json' \
  --data '
{
  "endpoint_id": "<string>",
  "event_type": "<string>",
  "payload": {}
}
'
{
  "status": "delivered",
  "http_status": 200
}
Sends a test event to a webhook endpoint using the full signing and delivery pipeline. Use this to verify that your endpoint is reachable and correctly verifying signatures before subscribing to real events. A confirmation email is sent to the authenticated user on success.

​
Parameters

​
endpoint_id
uuid
required
The ID of the webhook endpoint to test
​
event_type
string
Event type for the test payload. Defaults to webhook.test if omitted.
​
payload
object
Custom JSON payload to send. Defaults to {"status": "ok", "source": "test-delivery"} if omitted.

​
Responses

The response tells you whether the test delivery reached your endpoint and what HTTP status code it returned. 
{
  "status": "delivered",
  "http_status": 200
}
Use the test delivery endpoint during development to confirm your signature verification logic works correctly before going live. The test event goes through the same signing pipeline as real events.