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

# List event subscriptions

Retrieve all event subscriptions configured for your account.

```bash cURL theme={"theme":{"light":"github-light","dark":"github-dark"}}
curl --location 'https://www.headout.com/api/public/v2/event-subscriptions/' \
--header 'Headout-Auth: <YOUR_API_KEY>'
```

```json 200 theme={"theme":{"light":"github-light","dark":"github-dark"}}
{
  "items": [
    {
      "id": "whsub_01j9z8x7v6w5u4t3s2r1q0p9o8",
      "url": "https://your-domain.com/webhooks/headout/events",
      "eventTypes": ["product.listing_status_changed"],
      "description": "Production event subscription",
      "active": true,
      "createdAt": "2026-07-30T10:15:00Z",
      "updatedAt": "2026-07-30T10:15:00Z",
      "authentication": {
        "type": "AUTHORIZATION_HEADER",
        "valueHint": "oken"
      },
      "signingSecretHint": "B0eHyA"
    }
  ]
}
```


## OpenAPI

````yaml GET /api/public/v2/event-subscriptions/
openapi: 3.1.0
info:
  title: Headout API Docs - Common v2
  version: 0.0.1
servers:
  - url: https://www.headout.com
    description: Production server
  - url: https://www.sandbox-headout.com
    description: Sandbox server
security: []
paths:
  /api/public/v2/event-subscriptions/:
    get:
      tags:
        - Event Subscriptions
      summary: List event subscriptions
      operationId: v2ListEventSubscriptions
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventSubscriptionList'
      security:
        - apiKeyAuth: []
components:
  schemas:
    EventSubscriptionList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/EventSubscription'
          description: All event subscriptions for this partner.
    EventSubscription:
      type: object
      properties:
        id:
          type: string
          description: >-
            Identifier of this subscription, e.g. `whsub_01j...`. Use in
            Get/Update/Delete/Rotate secret.
        url:
          type: string
          description: HTTPS URL events are delivered to.
        eventTypes:
          type: array
          items:
            $ref: '#/components/schemas/EventSubscriptionType'
          description: Event types this subscription is subscribed to.
        description:
          type:
            - string
            - 'null'
          description: Free-text label for this subscription, if set.
        active:
          type: boolean
          description: Whether this subscription is currently active.
        createdAt:
          type: string
          format: date-time
          description: When this subscription was created.
        updatedAt:
          type: string
          format: date-time
          description: When this subscription was last updated.
        authentication:
          $ref: '#/components/schemas/EventSubscriptionAuthentication'
        signingSecret:
          type:
            - string
            - 'null'
          description: >-
            Signing secret for this subscription, used to verify the
            `X-Headout-Signature` header on delivered events. Only present in
            the response to Create event subscription and Rotate signing secret
            — never returned again afterwards, so store it immediately.
        signingSecretHint:
          type:
            - string
            - 'null'
          description: >-
            Masked trailing characters of the current signing secret, returned
            on reads so you can tell which secret is active without exposing it.
    EventSubscriptionType:
      type: string
      enum:
        - product.listing_status_changed
        - product.variant_listing_status_changed
        - product.data_changed
        - product.variant_pricing_changed
      description: >
        The event types available for subscription:

        - `product.listing_status_changed` — A product was listed or unlisted.

        - `product.variant_listing_status_changed` — One or more variants under
        a product were listed or unlisted. Fires when a product is listed (its
        variants arrive as listed) or delisted (all its variants are reported
        delisted), and also while a product stays listed but individual variants
        under it are listed or delisted.

        - `product.data_changed` — The content of a product that is listed (and
        was listed at the previous sync) changed. `data.changedFields` names
        which fields differ. Listing/unlisting and variant add/remove are
        reported by the two events above, not here.

        - `product.variant_pricing_changed` — The near-term pricing of a variant
        under a listed product changed for a specific date. `data` names the
        `productId`, `variantId`, and `date` whose price moved, not the new
        amounts — re-fetch the price to read them.
    EventSubscriptionAuthentication:
      type: object
      properties:
        type:
          type: string
          enum:
            - NONE
            - AUTHORIZATION_HEADER
          description: Authentication type configured for this subscription.
        valueHint:
          type:
            - string
            - 'null'
          description: >-
            Masked trailing characters of the configured `Authorization` header
            value. Only present when `type` is `AUTHORIZATION_HEADER`. The full
            value is never returned.
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: Headout-Auth

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.