MAmailchimp
batch-webhooks

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.

post/3.0/batch-webhooks

Request

Request body

enabledboolean

Whether the webhook receives requests or not.

urlstring required

A valid URL for the Webhook.

Example request

{
  "enabled": true,
  "url": "http://yourdomain.com/webhook"
}

Response

enabledboolean

Whether the webhook receives requests or not.

idstring

A string that uniquely identifies this Batch Webhook.

signing_enabledboolean

Whether outbound deliveries are HMAC-signed.

urlstring

A valid URL for the Webhook.

signing_secretstring

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.

Example response

{
  "enabled": true,
  "signing_enabled": true,
  "url": "http://yourdomain.com/webhook",
  "signing_secret": "zI3tsLziqBWhlz6V4PRlGg41u0gdhu7LhYXX4wa0ARM"
}

Changes

No recorded changes to this operation across all 1 revision of this API.