Webhook API Reference
Get Many Webhooks
Get your team's webhook endpoints with pagination and filtering.
Responses never include signing secrets or custom header values.
Authorization
api_key x-access-token<token>
In: header
Query Parameters
page?number
Page number for pagination (starting from 0)
Format
doubleDefault
0limit?number
Number of items per page (at most 50)
Format
doubleDefault
20status?string
Filter by status: active, paused or inactive (comma-separated for multiple values)
Default
""order_by?string
Field to order results by
Default
"created_at"Value in
- "created_at"
- "updated_at"
- "consecutive_failures"
order?string
Order direction
Value in
- "asc"
- "desc"
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"{ "data": [ { "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" } } ], "meta": { "page": 0.1, "page_size": 0.1, "has_next_page": true, "has_previous_page": true, "start_index": 0.1, "end_index": 0.1 }}