Webhooks
All webhooks Available
Returns all webhook subscriptions registered under your account. You can optionally filter by active status to see only enabled or disabled webhooks.
When to use: Call this endpoint to display the user's webhook configuration dashboard, verify that webhooks are correctly registered before going to production, or audit which event subscriptions are currently active.
Prerequisites:
- Valid JWT token in the Authorization header
Key behaviors:
- Returns an array of webhook objects, each containing id, type, url, and active status
- Use the optional active query parameter to filter: 1 returns only active webhooks, 0 returns only inactive ones; omitting the parameter returns all webhooks
- The type field indicates the event category (e.g., shipment created, tracking update); use GET /webhook-types to see all available types
- The webhook id returned can be used with PUT /webhooks/{webhook_id} to update the configuration
get/webhooks
Query parameters
active0 | 1
Filter by active status
Response
Webhooks retrieved successfully