Add webhook

POST

https://api.mailchimp.com/3.0/lists/:list_id/webhooks

POST

/3.0/lists/:list_id/webhooks

curl -X POST https://api.mailchimp.com/3.0/lists/list_id/webhooks \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

200Successful

{
  "_links": [
    {
      "href": "string",
      "method": "GET",
      "rel": "string",
      "schema": "string",
      "targetSchema": "string"
    }
  ],
  "events": {
    "campaign": true,
    "cleaned": true,
    "profile": true,
    "subscribe": true,
    "unsubscribe": true,
    "upemail": true,
    "sms_subscribe": true,
    "sms_unsubscribe": true,
    "upsms": true,
    "sms_campaign": true
  },
  "id": "5d9a5e3f7b",
  "list_id": "4ca5becb8d",
  "signing_enabled": true,
  "sources": {
    "admin": true,
    "api": true,
    "user": true
  },
  "url": "http://yourdomain.com/webhook",
  "signing_secret": "zI3tsLziqBWhlz6V4PRlGg41u0gdhu7LhYXX4wa0ARM"
}

Create a new webhook for a specific list.

Authentication

AuthorizationBearer

Authorization using a Mailchimp API key (a.k.a. Bearer token)

AuthorizationBearer

Authorization using OAuth

Path parameters

list_idstringRequired

The unique ID for the list.

Request

This endpoint expects an object.

eventsobjectOptional

The events that can trigger the webhook and whether they are enabled.

sourcesobjectOptional

The possible sources of any events that can trigger the webhook and whether they are enabled.

urlstringOptional

A valid URL for the Webhook.

Response

This endpoint returns an object.

_linkslist of objectsOptionalRead-only

A list of link types and descriptions for the API schema documents.

eventsobjectOptionalRead-only

The events that can trigger the webhook and whether they are enabled.

idstringOptionalRead-only

An string that uniquely identifies this webhook.

list_idstringOptionalRead-only

The unique id for the list.

signing_enabledbooleanOptionalRead-only

Whether outbound deliveries are HMAC-signed.

sourcesobjectOptionalRead-only

The possible sources of any events that can trigger the webhook and whether they are enabled.

urlstringOptionalRead-only

A valid URL for the Webhook.

signing_secretstringOptionalRead-only

The HMAC signing secret. Returned exactly once at creation. This should be stored securely; if lost, delete and recreate the webhook to obtain a new secret.