> ## Documentation Index
> Fetch the complete documentation index at: https://docs.returnqueen.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# List Webhooks

> Returns all webhook endpoints configured for the authenticated partner

<RequestExample>
  ```bash theme={null}
  curl -X GET \
    'https://platform.returnqueen.dev/api/partner_webhooks' \
    -H 'X-API-KEY: your-api-key'
  ```
</RequestExample>

<ResponseExample>
  ```json theme={null}
  {
    "webhooks": [
      {
        "id": "ep_2KtRQ8fTStWPKrXP",
        "url": "https://example.com/webhook",
        "filterTypes": ["shipment.created"],
        "active": true,
        "created_at": "2024-01-15T10:00:00Z",
        "description": "Production webhook endpoint"
      }
    ],
    "total": 1
  }
  ```
</ResponseExample>

## Response Fields

<ResponseField name="webhooks" type="array">
  List of webhook endpoints

  <Expandable title="webhook properties">
    <ResponseField name="id" type="string">
      Unique identifier for the webhook endpoint
    </ResponseField>

    <ResponseField name="url" type="string">
      HTTPS URL where webhook events are sent
    </ResponseField>

    <ResponseField name="filterTypes" type="array">
      Event types this endpoint is subscribed to (empty array means all events)
    </ResponseField>

    <ResponseField name="active" type="boolean">
      Whether the endpoint is active
    </ResponseField>

    <ResponseField name="created_at" type="string">
      When the endpoint was created (ISO 8601 format)
    </ResponseField>

    <ResponseField name="description" type="string">
      Description of the webhook endpoint
    </ResponseField>
  </Expandable>
</ResponseField>

<ResponseField name="total" type="integer">
  Total number of webhook endpoints
</ResponseField>