> ## 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 Webhook Event Types

> Returns all available webhook event types that partners can subscribe to

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

<ResponseExample>
  ```json theme={null}
  {
    "event_types": [
      {
        "name": "shipment.created",
        "description": "Triggered when a new shipment is created",
        "category": "shipment",
        "schema": {
          "shipment_id": "string",
          "order_number": "string",
          "status": "string",
          "created_at": "datetime"
        }
      },
      {
        "name": "shipment.cancelled",
        "description": "Triggered when a shipment is cancelled",
        "category": "shipment",
        "schema": {
          "shipment_id": "string",
          "order_number": "string",
          "cancelled_at": "datetime",
          "cancelled_reason": "string"
        }
      },
      {
        "name": "pickup.completed",
        "description": "Triggered when a pickup is completed",
        "category": "pickup",
        "schema": {
          "pickup_id": "string",
          "completed_at": "datetime",
          "shipment_ids": "array"
        }
      }
    ]
  }
  ```
</ResponseExample>

## Response Fields

<ResponseField name="event_types" type="array">
  List of available event types

  <Expandable title="event type properties">
    <ResponseField name="name" type="string">
      Event type identifier (e.g., "shipment.created")
    </ResponseField>

    <ResponseField name="description" type="string">
      Human-readable description of the event
    </ResponseField>

    <ResponseField name="category" type="string">
      Event category for grouping. One of:

      * `pickup`
      * `shipment`
      * `shipment_changes`
      * `item`
      * `batch`
      * `api`
    </ResponseField>

    <ResponseField name="schema" type="object">
      Expected payload schema for this event type
    </ResponseField>
  </Expandable>
</ResponseField>

<Note>
  Use these event type names when creating or updating webhook endpoints to filter which events you want to receive.
</Note>