---
title: "List webhooks"
method: GET
path: "/3.0/lists/{list_id}/webhooks"
tags: ["lists"]
---

# List webhooks

`GET /3.0/lists/{list_id}/webhooks`

## Request

- Base URL: `https://api.mailchimp.com`
- URL: `https://api.mailchimp.com/3.0/lists/{list_id}/webhooks`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://login.mailchimp.com/oauth2/authorize`
    - Token URL: `https://login.mailchimp.com/oauth2/token`
- TypeScript: <https://skmtc.dev/mailchimp/apis/mailchimp-api/docs/3.0/lists/:list_id/webhooks/get.ts> (a function with typed inputs; its response is checked against the schema)

Get information about all webhooks for a specific list.

## Path parameters

- `list_id` string, required

## Response `200`

- object: Manage webhooks for a specific list.
  - `_links` object[]: A list of link types and descriptions for the API schema documents.
    - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
    - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'.
    - `rel` string: As with an HTML 'rel' attribute, this describes the type of link.
    - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
    - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to.
  - `list_id` string: The list id.
  - `total_items` integer: The total number of items matching the query regardless of pagination.
  - `webhooks` object[]: An array of objects, each representing a specific list member.
    - `_links` object[]: A list of link types and descriptions for the API schema documents.
      - `href` string: This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      - `method` 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD': The HTTP method that should be used when accessing the URL defined in 'href'.
      - `rel` string: As with an HTML 'rel' attribute, this describes the type of link.
      - `schema` string: For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      - `targetSchema` string: For GETs, this is a URL representing the schema that the response should conform to.
    - `events` object: The events that can trigger the webhook and whether they are enabled.
      - `campaign` boolean: Whether the webhook is triggered when a campaign is sent or cancelled.
      - `cleaned` boolean: Whether the webhook is triggered when a subscriber's email address is cleaned from the list.
      - `profile` boolean: Whether the webhook is triggered when a contact's profile is updated. This includes email subscribers and SMS-only contacts [BETA].
      - `subscribe` boolean: Whether the webhook is triggered when a list subscriber is added.
      - `unsubscribe` boolean: Whether the webhook is triggered when a list member unsubscribes.
      - `upemail` boolean: Whether the webhook is triggered when a subscriber's email address is changed.
      - `sms_subscribe` boolean: [BETA] Whether the webhook is triggered when a contact subscribes to SMS.
      - `sms_unsubscribe` boolean: [BETA] Whether the webhook is triggered when a contact unsubscribes from SMS.
      - `upsms` boolean: [BETA] Whether the webhook is triggered when a contact's SMS phone number is updated.
      - `sms_campaign` boolean: [BETA] Whether the webhook is triggered when an SMS campaign is sent.
    - `id` string: An string that uniquely identifies this webhook.
    - `list_id` string: The unique id for the list.
    - `signing_enabled` boolean: Whether outbound deliveries are HMAC-signed.
    - `sources` object: The possible sources of any events that can trigger the webhook and whether they are enabled.
      - `admin` boolean: Whether the webhook is triggered by admin-initiated actions in the web interface.
      - `api` boolean: Whether the webhook is triggered by actions initiated via the API.
      - `user` boolean: Whether the webhook is triggered by subscriber-initiated actions.
    - `url` string: A valid URL for the Webhook.

## Other responses

- `default`: An error generated by the Mailchimp API.

---

[API](https://skmtc.dev/mailchimp/apis/mailchimp-api.md) - [All operations](https://skmtc.dev/mailchimp/apis/mailchimp-api/llms.txt) - [OpenAPI document](https://skmtc.dev/mailchimp/apis/mailchimp-api/revisions/53bf4b156855?raw)