Skip to main content
POST
/
api
/
webhooks
/
test
{
  "event_type": "api.webhook.test",
  "endpoint_id": "ep_2KtRQ8fTStWPKrXP"
}

{
  "message": "Test event sent successfully",
  "message_id": "msg_2KtRQ8fTStWPKrXQ",
  "endpoints_notified": 1
}

​
Request Body

​
event_type
string
default:"api.webhook.test"
Event type to send. Defaults to api.webhook.test
​
endpoint_id
string
Specific endpoint to test. If not provided, tests all active endpoints
{
  "event_type": "api.webhook.test",
  "endpoint_id": "ep_2KtRQ8fTStWPKrXP"
}

{
  "message": "Test event sent successfully",
  "message_id": "msg_2KtRQ8fTStWPKrXQ",
  "endpoints_notified": 1
}

​
Response Fields

​
message
string
Success message
​
message_id
string
ID of the test message sent
​
endpoints_notified
integer
Number of endpoints that were notified
This endpoint is useful for testing webhook configuration during development or debugging webhook delivery issues.

​
Test Event Payload

The test event sent to your webhook endpoint will have the following structure: 
{
  "id": "evt_test_123456789",
  "type": "api.webhook.test",
  "created": "2024-01-15T10:00:00Z",
  "data": {
    "message": "This is a test webhook event",
    "endpoint_id": "ep_2KtRQ8fTStWPKrXP"
  }
}