Webhooks

Manage webhooks for a specific MailChimp list. Learn more about webhooks in MailChimp.

Available methods

    • Create a new webhook

      POST /lists/{list_id}/webhooks

      Create a new webhook for a specific list.

      Path parameters

      list_id The unique id for the list.

      Request body parameters

      url Type: String Title: URL Read only: false A valid URL for the Webhook.
      events Type: Object Title: Events Read only: false The events that can trigger the webhook and whether they are enabled.
      Show properties
      subscribe Type: Boolean Title: Subscribed Read only: false Whether the webhook is triggered when a list subscriber is added.
      unsubscribe Type: Boolean Title: Unsubscribed Read only: false Whether the webhook is triggered when a list member unsubscribes.
      profile Type: Boolean Title: Profile Updated Read only: false Whether the webhook is triggered when a subscriber’s profile is updated.
      cleaned Type: Boolean Title: Cleaned Read only: false Whether the webhook is triggered when a subscriber’s email address is cleaned from the list.
      upemail Type: Boolean Title: Email Address Updated Read only: false Whether the webhook is triggered when a subscriber’s email address is changed.
      campaign Type: Boolean Title: Campaign Sent Read only: false Whether the webhook is triggered when a campaign is sent or cancelled.
      sources Type: Object Title: Sources Read only: false The possible sources of any events that can trigger the webhook and whether they are enabled.
      Show properties
      user Type: Boolean Title: User Read only: false Whether the webhook is triggered by subscriber-initiated actions.
      admin Type: Boolean Title: Admin Read only: false Whether the webhook is triggered by admin-initiated actions in the web interface.
      api Type: Boolean Title: API Read only: false Whether the webhook is triggered by actions initiated via the API.

      Response body parameters

      id Type: String Title: Unique ID Read only: true An string that uniquely identifies this webhook.
      url Type: String Title: URL Read only: true A valid URL for the Webhook.
      events Type: Object Title: Events Read only: true The events that can trigger the webhook and whether they are enabled.
      Show properties
      subscribe Type: Boolean Title: Subscribed Read only: false Whether the webhook is triggered when a list subscriber is added.
      unsubscribe Type: Boolean Title: Unsubscribed Read only: false Whether the webhook is triggered when a list member unsubscribes.
      profile Type: Boolean Title: Profile Updated Read only: false Whether the webhook is triggered when a subscriber’s profile is updated.
      cleaned Type: Boolean Title: Cleaned Read only: false Whether the webhook is triggered when a subscriber’s email address is cleaned from the list.
      upemail Type: Boolean Title: Email Address Updated Read only: false Whether the webhook is triggered when a subscriber’s email address is changed.
      campaign Type: Boolean Title: Campaign Sent Read only: false Whether the webhook is triggered when a campaign is sent or cancelled.
      sources Type: Object Title: Sources Read only: true The possible sources of any events that can trigger the webhook and whether they are enabled.
      Show properties
      user Type: Boolean Title: User Read only: false Whether the webhook is triggered by subscriber-initiated actions.
      admin Type: Boolean Title: Admin Read only: false Whether the webhook is triggered by admin-initiated actions in the web interface.
      api Type: Boolean Title: API Read only: false Whether the webhook is triggered by actions initiated via the API.
      list_id Type: String Title: List ID Read only: true The unique id for the list.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request POST \
      --url 'https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"url" : "http://requestb.in/u5nuzfu5", "events" : {"subscribe" : true, "unsubscribe" : true, "profile" : true, "cleaned" : true, "upemail" : true, "campaign" : true}, "sources" : {"user" : true, "admin" : true, "api" : true}}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Wed, 30 Mar 2016 19:10:08 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 839
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 2ffc97da-38db-43d1-b27c-b9a173f4de83
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Instance.json>; rel="describedBy"
      
      {
        "id": "ab24521a00",
        "url": "http://requestb.in/u5nuzfu5",
        "events": {
          "subscribe": true,
          "unsubscribe": true,
          "profile": true,
          "cleaned": true,
          "upemail": true,
          "campaign": true
        },
        "sources": {
          "user": true,
          "admin": true,
          "api": true
        },
        "list_id": "205d96e6b4",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks/ab24521a00",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Webhooks.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks/ab24521a00",
            "method": "DELETE"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • GET /lists/{list_id}/webhooks Get information about all webhooks for a specific list
      GET /lists/{list_id}/webhooks/{webhook_id} Get information about a specific webhook

      Get information about all webhooks for a specific list

      GET /lists/{list_id}/webhooks

      Get information about all webhooks for a specific list.

      Response body parameters

      webhooks Type: Array Title: Webhooks Read only: false An array of objects, each representing a specific list member.
      Show properties
      id Type: String Title: Unique ID Read only: true An string that uniquely identifies this webhook.
      url Type: String Title: URL Read only: true A valid URL for the Webhook.
      events Type: Object Title: Events Read only: true The events that can trigger the webhook and whether they are enabled.
      Show properties
      subscribe Type: Boolean Title: Subscribed Read only: false Whether the webhook is triggered when a list subscriber is added.
      unsubscribe Type: Boolean Title: Unsubscribed Read only: false Whether the webhook is triggered when a list member unsubscribes.
      profile Type: Boolean Title: Profile Updated Read only: false Whether the webhook is triggered when a subscriber’s profile is updated.
      cleaned Type: Boolean Title: Cleaned Read only: false Whether the webhook is triggered when a subscriber’s email address is cleaned from the list.
      upemail Type: Boolean Title: Email Address Updated Read only: false Whether the webhook is triggered when a subscriber’s email address is changed.
      campaign Type: Boolean Title: Campaign Sent Read only: false Whether the webhook is triggered when a campaign is sent or cancelled.
      sources Type: Object Title: Sources Read only: true The possible sources of any events that can trigger the webhook and whether they are enabled.
      Show properties
      user Type: Boolean Title: User Read only: false Whether the webhook is triggered by subscriber-initiated actions.
      admin Type: Boolean Title: Admin Read only: false Whether the webhook is triggered by admin-initiated actions in the web interface.
      api Type: Boolean Title: API Read only: false Whether the webhook is triggered by actions initiated via the API.
      list_id Type: String Title: List ID Read only: true The unique id for the list.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.
      list_id Type: String Title: List ID Read only: false The list id.
      total_items Type: Integer Title: Item Count Read only: false The total number of items matching the query regardless of pagination.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Wed, 30 Mar 2016 19:04:57 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 2366
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: fe3f9176-bc66-4dce-af3d-a591dac3cbc8
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Collection.json>; rel="describedBy"
      
      {
        "webhooks": [
          {
            "id": "37b9c73a88",
            "url": "http://requestb.in/1g40c921",
            "events": {
              "subscribe": true,
              "unsubscribe": true,
              "profile": true,
              "cleaned": true,
              "upemail": true,
              "campaign": true
            },
            "sources": {
              "user": true,
              "admin": true,
              "api": false
            },
            "list_id": "205d96e6b4",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks/37b9c73a88",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Webhooks.json"
              },
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks/37b9c73a88",
                "method": "DELETE"
              }
            ]
          },
          {
            "id": "384a36d75e",
            "url": "http://requestb.in/190sjl31",
            "events": {
              "subscribe": true,
              "unsubscribe": true,
              "profile": false,
              "cleaned": false,
              "upemail": false,
              "campaign": false
            },
            "sources": {
              "user": false,
              "admin": false,
              "api": true
            },
            "list_id": "205d96e6b4",
            "_links": [
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks/384a36d75e",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Instance.json"
              },
              {
                "rel": "parent",
                "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks",
                "method": "GET",
                "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Collection.json",
                "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Webhooks.json"
              },
              {
                "rel": "self",
                "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks/384a36d75e",
                "method": "DELETE"
              }
            ]
          }
        ],
        "list_id": "205d96e6b4",
        "total_items": 2,
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Webhooks.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Instance.json"
          },
          {
            "rel": "create",
            "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks",
            "method": "POST",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Create.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.

      Get information about a specific webhook

      GET /lists/{list_id}/webhooks/{webhook_id}

      Get information about a specific webhook.

      Response body parameters

      id Type: String Title: Unique ID Read only: true An string that uniquely identifies this webhook.
      url Type: String Title: URL Read only: true A valid URL for the Webhook.
      events Type: Object Title: Events Read only: true The events that can trigger the webhook and whether they are enabled.
      Show properties
      subscribe Type: Boolean Title: Subscribed Read only: false Whether the webhook is triggered when a list subscriber is added.
      unsubscribe Type: Boolean Title: Unsubscribed Read only: false Whether the webhook is triggered when a list member unsubscribes.
      profile Type: Boolean Title: Profile Updated Read only: false Whether the webhook is triggered when a subscriber’s profile is updated.
      cleaned Type: Boolean Title: Cleaned Read only: false Whether the webhook is triggered when a subscriber’s email address is cleaned from the list.
      upemail Type: Boolean Title: Email Address Updated Read only: false Whether the webhook is triggered when a subscriber’s email address is changed.
      campaign Type: Boolean Title: Campaign Sent Read only: false Whether the webhook is triggered when a campaign is sent or cancelled.
      sources Type: Object Title: Sources Read only: true The possible sources of any events that can trigger the webhook and whether they are enabled.
      Show properties
      user Type: Boolean Title: User Read only: false Whether the webhook is triggered by subscriber-initiated actions.
      admin Type: Boolean Title: Admin Read only: false Whether the webhook is triggered by admin-initiated actions in the web interface.
      api Type: Boolean Title: API Read only: false Whether the webhook is triggered by actions initiated via the API.
      list_id Type: String Title: List ID Read only: true The unique id for the list.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request GET \
      --url 'https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks/37b9c73a88' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: nginx
      Date: Wed, 30 Mar 2016 19:19:01 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 834
      Connection: keep-alive
      Vary: Accept-Encoding
      X-Request-Id: 363bfc44-6dac-4987-afe2-e8d996a90555
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Instance.json>; rel="describedBy"
      
      {
        "id": "37b9c73a88",
        "url": "http://requestb.in/1g40c921",
        "events": {
          "subscribe": true,
          "unsubscribe": true,
          "profile": true,
          "cleaned": true,
          "upemail": true,
          "campaign": true
        },
        "sources": {
          "user": true,
          "admin": true,
          "api": false
        },
        "list_id": "205d96e6b4",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks/37b9c73a88",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Instance.json"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Webhooks.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks/37b9c73a88",
            "method": "DELETE"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • Update a webhook

      PATCH /lists/{list_id}/webhooks/{webhook_id}

      Update the settings for an existing webhook.

      Path parameters

      list_id The unique id for the list.

      Request body parameters

      url Type: String Title: URL Read only: false A valid URL for the Webhook.
      events Type: Object Title: Events Read only: false The events that can trigger the webhook and whether they are enabled.
      Show properties
      subscribe Type: Boolean Title: Subscribed Read only: false Whether the webhook is triggered when a list subscriber is added.
      unsubscribe Type: Boolean Title: Unsubscribed Read only: false Whether the webhook is triggered when a list member unsubscribes.
      profile Type: Boolean Title: Profile Updated Read only: false Whether the webhook is triggered when a subscriber’s profile is updated.
      cleaned Type: Boolean Title: Cleaned Read only: false Whether the webhook is triggered when a subscriber’s email address is cleaned from the list.
      upemail Type: Boolean Title: Email Address Updated Read only: false Whether the webhook is triggered when a subscriber’s email address is changed.
      campaign Type: Boolean Title: Campaign Sent Read only: false Whether the webhook is triggered when a campaign is sent or cancelled.
      sources Type: Object Title: Sources Read only: false The possible sources of any events that can trigger the webhook and whether they are enabled.
      Show properties
      user Type: Boolean Title: User Read only: false Whether the webhook is triggered by subscriber-initiated actions.
      admin Type: Boolean Title: Admin Read only: false Whether the webhook is triggered by admin-initiated actions in the web interface.
      api Type: Boolean Title: API Read only: false Whether the webhook is triggered by actions initiated via the API.

      Response body parameters

      id Type: String Title: Unique ID Read only: true An string that uniquely identifies this webhook.
      url Type: String Title: URL Read only: true A valid URL for the Webhook.
      events Type: Object Title: Events Read only: true The events that can trigger the webhook and whether they are enabled.
      Show properties
      subscribe Type: Boolean Title: Subscribed Read only: false Whether the webhook is triggered when a list subscriber is added.
      unsubscribe Type: Boolean Title: Unsubscribed Read only: false Whether the webhook is triggered when a list member unsubscribes.
      profile Type: Boolean Title: Profile Updated Read only: false Whether the webhook is triggered when a subscriber’s profile is updated.
      cleaned Type: Boolean Title: Cleaned Read only: false Whether the webhook is triggered when a subscriber’s email address is cleaned from the list.
      upemail Type: Boolean Title: Email Address Updated Read only: false Whether the webhook is triggered when a subscriber’s email address is changed.
      campaign Type: Boolean Title: Campaign Sent Read only: false Whether the webhook is triggered when a campaign is sent or cancelled.
      sources Type: Object Title: Sources Read only: true The possible sources of any events that can trigger the webhook and whether they are enabled.
      Show properties
      user Type: Boolean Title: User Read only: false Whether the webhook is triggered by subscriber-initiated actions.
      admin Type: Boolean Title: Admin Read only: false Whether the webhook is triggered by admin-initiated actions in the web interface.
      api Type: Boolean Title: API Read only: false Whether the webhook is triggered by actions initiated via the API.
      list_id Type: String Title: List ID Read only: true The unique id for the list.
      _links Type: Array Title: Links Read only: true A list of link types and descriptions for the API schema documents.
      Show properties
      rel Type: String Title: Rel Read only: true As with an HTML ‘rel’ attribute, this describes the type of link.
      href Type: String Title: Href Read only: true This property contains a fully-qualified URL that can be called to retrieve the linked resource or perform the linked action.
      method Type: String Title: Method Read only: true The HTTP method that should be used when accessing the URL defined in ‘href’.
      Possible Values:
      • GET
      • POST
      • PUT
      • PATCH
      • DELETE
      • OPTIONS
      • HEAD
      targetSchema Type: String Title: Target Schema Read only: true For GETs, this is a URL representing the schema that the response should conform to.
      schema Type: String Title: Schema Read only: true For HTTP methods that can receive bodies (POST and PUT), this is a URL representing the schema that the body should conform to.

      Example request

      
      curl --request PATCH \
      --url 'https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/webhooks/8de72ada47' \
      --user 'anystring:apikey' \
      --header 'content-type: application/json' \
      --data '{"events" : {"subscribe" : true, "unsubscribe" : true, "profile" : false, "cleaned" : false, "upemail" : false, "campaign" : true}, "sources" : {"user" : false, "admin" : true, "api" : true}}' \
      --include
                                      

      Example response

      
      HTTP/1.1 200 OK
      Server: openresty
      Content-Type: application/json; charset=utf-8
      Content-Length: 1107
      Vary: Accept-Encoding
      X-Request-Id: d6a82ecb-0de3-453a-b656-db126aa6d8a2
      Link: <https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Instance.json>; rel="describedBy"
      Date: Wed, 26 Oct 2016 17:52:29 GMT
      Connection: keep-alive
      
      {
        "id": "8de72ada47",
        "url": "http://requestb.in/19ghhxo1",
        "events": {
          "subscribe": true,
          "unsubscribe": true,
          "profile": false,
          "cleaned": false,
          "upemail": false,
          "campaign": true
        },
        "sources": {
          "user": false,
          "admin": true,
          "api": true
        },
        "list_id": "3da7c56ccb",
        "_links": [
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/webhooks/8de72ada47",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Instance.json"
          },
          {
            "rel": "create",
            "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/webhooks",
            "method": "POST",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Instance.json",
            "schema": "https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Instance.json"
          },
          {
            "rel": "self",
            "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/webhooks/8de72ada47",
            "method": "DELETE"
          },
          {
            "rel": "parent",
            "href": "https://usX.api.mailchimp.com/3.0/lists/3da7c56ccb/webhooks",
            "method": "GET",
            "targetSchema": "https://api.mailchimp.com/schema/3.0/Lists/Webhooks/Collection.json",
            "schema": "https://api.mailchimp.com/schema/3.0/CollectionLinks/Lists/Webhooks.json"
          }
        ]
      }
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.
    • Delete a webhook

      DELETE /lists/{list_id}/webhooks/{webhook_id}

      Delete a specific webhook in a list.

      Example request

      
      curl --request DELETE \
      --url 'https://usX.api.mailchimp.com/3.0/lists/205d96e6b4/webhooks/37b9c73a88' \
      --user 'anystring:apikey' \
      --include
                                      

      Example response

      
      HTTP/1.1 204 No Content
      Server: nginx
      Date: Wed, 30 Mar 2016 19:20:29 GMT
      Content-Type: application/json; charset=utf-8
      Content-Length: 0
      Connection: keep-alive
      X-Request-Id: 81243664-0b84-4141-876c-012ce8cecd78
                                      

      Error response

      type Type: String Title: Problem Type Read only: false An absolute URI that identifies the problem type. When dereferenced, it should provide human-readable documentation for the problem type.
      title Type: String Title: Error Title Read only: false A short, human-readable summary of the problem type. It shouldn’t change based on the occurrence of the problem, except for purposes of localization.
      status Type: Integer Title: HTTP Status Code Read only: false The HTTP status code (RFC2616, Section 6) generated by the origin server for this occurrence of the problem.
      detail Type: String Title: Error Message Read only: false A human-readable explanation specific to this occurrence of the problem. Learn more about errors.
      instance Type: String Title: Instance ID Read only: false A string that identifies this specific occurrence of the problem. Please provide this ID when contacting support.