Api referenceEndpointsAdmin
Send a test event (instance admin, one tenant)
POST
POST /v1/webhooks/{webhook_id}/test (testWebhook) for the tenant of tenant_id, run with an
instance admin key: the same body, parameters and answer as the tenant's own key
gets; a Location points at the admin route. Recorded in the caller's audit log
and, actor admin, in the tenant's.
See docs/admin-api.md.
tenantKeyheader
AuthorizationBearer <token>Tenant API key, ohs_sk_ + 43 base62 characters.
tenant_id*stringThe id of a tenant; any other value is a 404.
Format
uuidwebhook_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/admin/tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08/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}