Api referenceEndpointsWebhooks
Send a test event
POST
Queues a test event for this endpoint alone, whatever its event types. Without a body (or
with event_type webhook.test) it is the generic webhook.test event. With another
event_type it is a realistic sample of that event, about no real user (user_id is the
nil UUID, external_ref is sample-user). Either payload carries "test": true.
tenantKeyheader
AuthorizationBearer <token>Tenant API key, ohs_sk_ + 43 base62 characters.
webhook_id*stringFormat
uuidapplication/json- body
event_type?|The event to send a sample of. Absent means webhook.test.
Queued.
application/json- response
id*integerevent_id*stringThe webhook-id header and the payload's id.
Format
uuidevent_type*stringstatus*stringparked after 8 failed attempts (about 28 hours), or when the endpoint was disabled.
Value in
"pending""running""done""parked"attempts*integerlast_status_code*integer|nulllast_error*string|nullnext_attempt_at*|Format
date-timecreated_at*stringFormat
date-timedelivered_at*|Format
date-timereplay_of*|The delivery this one replays (same event and payload); null for an original.
curl -X POST 'http://localhost:8080/v1/webhooks/497f6eca-6276-4993-bfeb-53cbbbba6f08/test' \ -H 'Authorization: Bearer ohs_sk_...' \ -H 'Content-Type: application/json' \ -d '{}'{ "id": 0, "event_id": "a7a26ff2-e851-45b6-9634-d595f45458b7", "event_type": "string", "status": "pending", "attempts": 0, "last_status_code": 0, "last_error": "string", "next_attempt_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "delivered_at": "2019-08-24T14:15:22Z", "replay_of": 0}