> ## Documentation Index > Fetch the complete documentation index at: https://developers.teleship.com/llms.txt > Use this file to discover all available pages before exploring further. # 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 ```json [ { "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. ## OpenAPI ````yaml /api-reference/openapi.json get /api/webhooks openapi: 3.0.0 info: title: Teleship description: > Teleship is a leading cross-border logistics provider offering seamless global commerce solutions through our comprehensive API. With Teleship's API, developers can integrate our cross-border shipping services, trade engine, and logistics solutions directly into their applications. **Key Features:** - Cross-border shipping solutions for international commerce - Real-time shipping rates and delivery estimates - End-to-end shipment tracking with detailed status updates - Automated customs compliance and product classification - Real-time event notifications through webhooks **Why Teleship?** - API-first: Developer-friendly integration with comprehensive documentation - Enterprise-ready: Built for businesses of all sizes - Secure: Enterprise-grade security and compliance - Integrated: Seamless connection with e-commerce, ERP, and fulfillment systems Start shipping globally with Teleship's powerful cross-border logistics API. version: 1.0.0 contact: {} servers: - url: https://api.teleship.com security: [] tags: [] paths: /api/webhooks: get: tags: - Shipping Services summary: Get all webhooks description: >- 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 ```json [ { "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. operationId: getAllWebhooks parameters: - name: range required: false in: query description: Range parameter in format [start, end] schema: example: '[0, 49]' type: string - name: _end required: false in: query schema: type: string - name: _start required: false in: query schema: type: string - name: _sort required: false in: query schema: type: string - name: _order required: false in: query schema: type: string - name: q required: false in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/WebhooksEntity' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ResponseMessagesDto' '404': description: Webhook not found content: application/json: schema: $ref: '#/components/schemas/ResponseMessagesDto' '500': description: Internal server error content: application/json: schema: $ref: '#/components/schemas/ResponseMessagesDto' security: - bearer: [] components: schemas: WebhooksEntity: type: object properties: id: type: string accountId: type: string url: type: string description: type: string secret: type: string metadata: type: object enabled: type: boolean enabledEvents: type: array items: type: string createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - accountId - url - description - enabled - enabledEvents - createdAt - updatedAt ResponseMessagesDto: type: object properties: messages: type: array items: $ref: '#/components/schemas/ErrorResponseDto' required: - messages ErrorResponseDto: type: object properties: code: type: number level: type: string enum: - error - warning - info example: error description: Error level default: error timestamp: format: date-time type: string example: '2024-01-01T00:00:00.00Z' message: type: string example: An error occurred details: example: - Missing required field type: array items: type: string required: - code - level - timestamp - message - details securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http ````