Webhook API Reference
Get Webhook
Get a webhook endpoint by its ID.
The response never includes the signing secret or custom header values.
Authorization
api_key x-access-token<token>
In: header
Path Parameters
webhook_id*string
ID of the webhook endpoint
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
curl -X GET "https://example.com/shipos/webhooks/string"{ "id": "string", "url": "string", "description": "string", "contact_email": "string", "paused": true, "active": true, "status": "active", "event_patterns": [ "string" ], "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "health": { "consecutive_failures": 0.1, "last_successful_at": "2019-08-24T14:15:22Z" }, "circuit": { "opened_at": "2019-08-24T14:15:22Z", "reason": "string", "probe_at": "2019-08-24T14:15:22Z" }, "supported_actions": [ { "action": "VIEW_LOGS" } ], "last_delivery": { "event_type": "string", "status": "PENDING", "delivered_at": "2019-08-24T14:15:22Z" }}