---
title: "Add batch webhook"
method: POST
path: "/3.0/batch-webhooks"
tags: ["batch-webhooks"]
---

# Add batch webhook

`POST /3.0/batch-webhooks`

## Request

- Base URL: `https://api.mailchimp.com`
- URL: `https://api.mailchimp.com/3.0/batch-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/batch-webhooks/post.ts> (a function with typed inputs; its response is checked against the schema)

Configure a webhook that will fire whenever any batch request completes processing.  You may only have a maximum of 20 batch webhooks.

## Request body

- object: Add a new Batch Webook.
  - `enabled` boolean: Whether the webhook receives requests or not.
  - `url` string, required: A valid URL for the Webhook.

## Response `200`

- object: A webhook configured for batch status updates.
  - `_links` array[]: A list of link types and descriptions for the API schema documents.
    - 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.
  - `enabled` boolean: Whether the webhook receives requests or not.
  - `id` string: A string that uniquely identifies this Batch Webhook.
  - `signing_enabled` boolean: Whether outbound deliveries are HMAC-signed.
  - `url` string: A valid URL for the Webhook.
  - `signing_secret` string: 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.

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