Get all webhooks
Shipping services
Get all webhooks
Retrieve a list of all webhook endpoints you have registered.
Overview
This endpoint returns all webhook endpoints associated with your account, including their configuration, status, and metadata.
Response Details
Each webhook in the response includes:
- id: Unique identifier for the webhook
- url: The endpoint URL where webhooks are sent
- description: Optional description of the webhook’s purpose
- enabledEvents: Array of events this webhook is subscribed to
- enabled: Whether the webhook is currently active
- metadata: Custom key-value pairs attached to the webhook
- createdAt: When the webhook was created
- updatedAt: When the webhook was last modified
Pagination
The response supports pagination using query parameters:
- _start: Starting index (default: 0)
- _end: Ending index (default: 10)
- _sort: Field to sort by (default: createdAt)
- _order: Sort order - ASC or DESC (default: ASC)
Example Response
[
{
"id": "wh_1234567890",
"url": "https://your-app.com/webhooks/teleship",
"description": "Production webhook for order updates",
"enabledEvents": ["label.generated", "shipment.updated"],
"enabled": true,
"metadata": {
"environment": "production",
"team": "shipping"
},
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:30:00Z"
},
{
"id": "wh_0987654321",
"url": "https://staging.your-app.com/webhooks/teleship",
"description": "Staging webhook for testing",
"enabledEvents": ["*"],
"enabled": false,
"metadata": {
"environment": "staging"
},
"createdAt": "2024-01-10T14:20:00Z",
"updatedAt": "2024-01-12T09:15:00Z"
}
]
Webhook Management
Use this endpoint to:
- Audit your webhooks - Review all registered endpoints
- Check webhook status - Verify which webhooks are enabled/disabled
- Monitor configuration - Ensure webhooks are subscribed to the right events
- Troubleshoot issues - Identify webhooks that might be causing problems
Security Note
The webhook secret is not included in the response for security reasons. The secret is only returned when creating a new webhook.
GET
Get all webhooks
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Range parameter in format [start, end]
Example:
"[0, 49]"