> ## 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).

export const DynamicResponseExample = ({json, statusCode = "200"}) => {
  const toCamelCase = str => {
    return str.replace(/_([a-z])/g, (_, c) => c.toUpperCase());
  };
  const convertKeysToCamelCase = obj => {
    if (Array.isArray(obj)) {
      return obj.map(item => convertKeysToCamelCase(item));
    }
    if (obj !== null && typeof obj === "object") {
      return Object.keys(obj).reduce((acc, key) => {
        const camelKey = toCamelCase(key);
        acc[camelKey] = convertKeysToCamelCase(obj[key]);
        return acc;
      }, {});
    }
    return obj;
  };
  const [isTypeScript, setIsTypeScript] = useState(() => {
    if (typeof window !== "undefined") {
      try {
        const lang = localStorage.getItem("code");
        return JSON.parse(lang) === "typescript";
      } catch {
        return true;
      }
    }
    return true;
  });
  useEffect(() => {
    const onMintlifyStorage = event => {
      if (event.detail?.key === "code") {
        try {
          const value = JSON.parse(event.detail.value);
          setIsTypeScript(value === "typescript");
        } catch {}
      }
    };
    const pollInterval = setInterval(() => {
      try {
        const lang = localStorage.getItem("code");
        const value = JSON.parse(lang);
        setIsTypeScript(value === "typescript");
      } catch {}
    }, 300);
    document.addEventListener("mintlify-localstorage", onMintlifyStorage);
    return () => {
      document.removeEventListener("mintlify-localstorage", onMintlifyStorage);
      clearInterval(pollInterval);
    };
  }, []);
  const camelCaseJson = useMemo(() => convertKeysToCamelCase(json), [json]);
  const snakeCaseString = JSON.stringify(json, null, 2);
  const camelCaseString = JSON.stringify(camelCaseJson, null, 2);
  return <ResponseExample>
			{isTypeScript ? <CodeBlock language="json" filename={statusCode}>
					{camelCaseString}
				</CodeBlock> : <CodeBlock language="json" filename={statusCode}>
					{snakeCaseString}
				</CodeBlock>}
		</ResponseExample>;
};

export const DynamicResponseField = ({children, name, ...props}) => {
  const convertToCamelCase = str => {
    if (typeof str !== "string") return str;
    return str.replace(/[_-](\w)/g, (_, c) => c.toUpperCase());
  };
  const [lang, setLang] = useState(() => {
    if (typeof window !== "undefined") {
      const stored = localStorage.getItem("code");
      return stored || '"typescript"';
    }
    return '"typescript"';
  });
  useEffect(() => {
    const onMintlifyStorage = event => {
      const key = event.detail?.key;
      if (key === "code") {
        setLang(event.detail.value);
      }
    };
    const pollInterval = setInterval(() => {
      const current = localStorage.getItem("code");
      if (current && current !== lang) {
        setLang(current);
      }
    }, 500);
    document.addEventListener("mintlify-localstorage", onMintlifyStorage);
    return () => {
      document.removeEventListener("mintlify-localstorage", onMintlifyStorage);
      clearInterval(pollInterval);
    };
  }, [lang]);
  const resolvedName = useMemo(() => {
    try {
      const value = JSON.parse(lang);
      const useCamelCase = value === "typescript";
      return useCamelCase ? convertToCamelCase(name) : name;
    } catch {
      return name;
    }
  }, [name, lang]);
  return <ResponseField name={resolvedName} {...props}>
			{children}
		</ResponseField>;
};

export const DynamicParamField = ({children, body, path, ...props}) => {
  const convertToCamelCase = str => {
    if (typeof str !== "string") return str;
    return str.replace(/[_-](\w)/g, (_, c) => c.toUpperCase());
  };
  const [lang, setLang] = useState(() => {
    if (typeof window !== "undefined") {
      const stored = localStorage.getItem("code");
      return stored || '"typescript"';
    }
    return '"typescript"';
  });
  useEffect(() => {
    const onMintlifyStorage = event => {
      const key = event.detail?.key;
      if (key === "code") {
        setLang(event.detail.value);
      }
    };
    const pollInterval = setInterval(() => {
      const current = localStorage.getItem("code");
      if (current && current !== lang) {
        setLang(current);
      }
    }, 500);
    document.addEventListener("mintlify-localstorage", onMintlifyStorage);
    return () => {
      document.removeEventListener("mintlify-localstorage", onMintlifyStorage);
      clearInterval(pollInterval);
    };
  }, [lang]);
  const resolvedBody = useMemo(() => {
    try {
      const value = JSON.parse(lang);
      const useCamelCase = value === "typescript";
      return useCamelCase ? convertToCamelCase(body) : body;
    } catch {
      return body;
    }
  }, [body, lang]);
  const resolvedPath = useMemo(() => {
    try {
      const value = JSON.parse(lang);
      const useCamelCase = value === "typescript";
      return useCamelCase ? convertToCamelCase(path) : path;
    } catch {
      return path;
    }
  }, [path, lang]);
  return <ParamField body={resolvedBody} path={resolvedPath} {...props}>
			{children}
		</ParamField>;
};

### Response

<DynamicResponseField name="list" type="object[]">
  The environment's webhooks.

  <Expandable title="properties">
    <DynamicResponseField name="id" type="string">
      The webhook's ID. Webhooks made in the dashboard show their `ep_…` ID.
    </DynamicResponseField>

    <DynamicResponseField name="url" type="string">
      The URL Autumn sends events to.
    </DynamicResponseField>

    <DynamicResponseField name="description" type="string | null">
      A note for your own reference.
    </DynamicResponseField>

    <DynamicResponseField name="events" type="string[]">
      The events sent to this webhook, as `WebhookEventType` names; a type newer than your client is returned as-is. Empty only for a webhook made in the dashboard that receives every event.
    </DynamicResponseField>

    <DynamicResponseField name="disabled" type="boolean">
      When true, no events are sent to the webhook.
    </DynamicResponseField>

    <DynamicResponseField name="created_at" type="number">
      When the webhook was created, ms since epoch.
    </DynamicResponseField>

    <DynamicResponseField name="updated_at" type="number">
      When the webhook was last changed, ms since epoch.
    </DynamicResponseField>
  </Expandable>
</DynamicResponseField>

<ResponseExample>
  ```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
      }
    ]
  }
  ```
</ResponseExample>


## OpenAPI

````yaml openapi POST /v1/webhooks.list
openapi: 3.1.0
info:
  title: Autumn API
  version: 2.4.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.4.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 only for a webhook
                            made in the dashboard that 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

````