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

# List Webhooks

> Lists every webhook in the environment of the calling key, including ones made in the dashboard (these show their `ep_…` ID).

### Response

The environment's webhooks.

**properties**

The webhook's ID. Webhooks made in the dashboard show their `ep_…` ID.

The URL Autumn sends events to.

A note for your own reference.

The events sent to this webhook, as `WebhookEventType` names; a type newer than your client is returned as-is. Empty means the webhook receives every event.

When true, no events are sent to the webhook.

When the webhook was created, ms since epoch.

When the webhook was last changed, ms since epoch.

```json 200 theme={null}
{
  "list": [
    {
      "id": "billing",
      "url": "https://example.com/webhooks/autumn",
      "events": [
        "billing.updated",
        "invoice.finalized"
      ],
      "description": "Plan changes and invoices",
      "disabled": false,
      "created_at": 1781113864000,
      "updated_at": 1781113864000
    }
  ]
}
```


## OpenAPI

````yaml openapi POST /v1/webhooks.list
openapi: 3.1.0
info:
  title: Autumn API
  version: 2.6.0
servers:
  - url: https://api.useautumn.com
    description: Production server
security:
  - secretKey: []
paths:
  /v1/webhooks.list:
    post:
      tags:
        - webhooks
      description: >-
        Lists every webhook in the environment of the calling key, including
        ones made in the dashboard (these show their `ep_…` ID).
      operationId: listWebhooks
      parameters:
        - name: x-api-version
          in: header
          required: true
          schema:
            type: string
            default: 2.6.0
          x-speakeasy-globals-hidden: true
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              title: ListWebhooksParams
              description: >-
                No body. Lists every webhook in the environment of the calling
                key.
              examples:
                - {}
            example: {}
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  list:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: >-
                            The webhook's ID. Webhooks made in the dashboard
                            show their `ep_…` ID.
                        url:
                          type: string
                          description: The URL Autumn sends events to.
                        description:
                          anyOf:
                            - type: string
                            - type: 'null'
                          description: A note for your own reference.
                        events:
                          type: array
                          items:
                            type: string
                          description: >-
                            The events sent to this webhook, as
                            `WebhookEventType` names; a type newer than your
                            client is returned as-is. Empty means the webhook
                            receives every event.
                        disabled:
                          type: boolean
                          description: When true, no events are sent to the webhook.
                        created_at:
                          type: number
                          description: When the webhook was created, ms since epoch.
                        updated_at:
                          type: number
                          description: When the webhook was last changed, ms since epoch.
                      required:
                        - id
                        - url
                        - description
                        - events
                        - disabled
                        - created_at
                        - updated_at
                    description: The environment's webhooks.
                required:
                  - list
                title: ListWebhooksResponse
                examples:
                  - list:
                      - id: billing
                        url: https://example.com/webhooks/autumn
                        events:
                          - billing.updated
                          - invoice.finalized
                        description: Plan changes and invoices
                        disabled: false
                        created_at: 1781113864000
                        updated_at: 1781113864000
              example:
                list:
                  - id: billing
                    url: https://example.com/webhooks/autumn
                    events:
                      - billing.updated
                      - invoice.finalized
                    description: Plan changes and invoices
                    disabled: false
                    created_at: 1781113864000
                    updated_at: 1781113864000
      x-codeSamples:
        - lang: typescript
          label: Typescript (SDK)
          source: |-
            import { Autumn } from 'autumn-js'

            const autumn = new Autumn()

            const result = await autumn.webhooks.list({});
        - lang: python
          label: Python (SDK)
          source: |-
            from autumn_sdk import Autumn

            autumn = Autumn(secret_key="am_sk_test...")

            res = autumn.webhooks.list(
                request={},
            )
components:
  securitySchemes:
    secretKey:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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