Skip to content
Dashboard
Theme
Theme

Send a sample event

POST /v1/webhook_endpoints/{endpoint}/test: Send a sample event.

View Markdown

POST /v1/webhook_endpoints/{endpoint}/test

Scope
webhooks:write
Auth
Secret key (sk_…)
Since
1.0
  • endpoint string Required

  • OhAuthCat-Version string

    Minor version; defaults to the environment’s pin.

  • Idempotency-Key string

    Honoured for 24 h; a replay returns the original response.

    min length 1 · max length 255

  • type string Required

    min length 1

Errors share one shape; see the error code catalogue.

curl -X POST \
"https://api.ohauthcat.com/v1/webhook_endpoints/whep_01J9Z3K5V7W8X9Y0Z1A2B3C4D5/test" \
-H "Authorization: Bearer $OHAUTHCAT_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"type": "default"
}'
Response 200
{
"format": "native",
"id": "whdl_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"object": "webhook_delivery",
"endpoint_id": "whep_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"event_id": "evt_01J9Z3K5V7W8X9Y0Z1A2B3C4D5",
"status": "pending",
"attempts": 1,
"response_status": 1,
"event_type": "user.signed_in",
"duration_ms": 0,
"next_attempt_at": "2026-01-15T09:30:00Z",
"request": {
"method": "POST",
"url": "https://app.acme.com/callback",
"headers": {},
"body": "example_body",
"body_truncated": true
},
"error": "example_error",
"response": {
"status": 1,
"headers": {},
"body": "example_body"
},
"created_at": "2026-01-15T09:30:00Z"
}