Skip to navigation

Add batch webhook

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

Authentication

AuthorizationBearer

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

OR
AuthorizationBearer
Authorization using OAuth

Request

Add a new Batch Webook.
urlstringRequired
A valid URL for the Webhook.
enabledbooleanOptional
Whether the webhook receives requests or not.

Response

This endpoint returns an object.
enabledbooleanOptional
Whether the webhook receives requests or not.
idstringOptionalRead-only
A string that uniquely identifies this Batch Webhook.
signing_enabledbooleanOptionalRead-only

Whether outbound deliveries are HMAC-signed.

urlstringOptional
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.