account-exports3

activity-feed2

audiences6

authorized-apps2

automations18

batch-webhooks5

batches4

campaign-folders5

campaigns22

connected-sites5

conversations4

customer-journeys1

ecommerce60

facebook-ads2

file-manager12

landing-pages8

lists70

ping1

reporting13

reports22

root1

search-campaigns1

search-members1

segments9

sms-campaigns10

surveys3

template-folders5

templates6

verified-domains5

batch-webhooks

Get batch webhook info

Get information about a specific batch webhook.

get/3.0/batch-webhooks/{batch_webhook_id}

Request

Base URL
https://api.mailchimp.com
Auth
- HTTP bearer
- or OAuth 2
  Authorization codehttps://login.mailchimp.com/oauth2/authorize
  Token URLhttps://login.mailchimp.com/oauth2/token
TypeScript
https://skmtc.dev/mailchimp/apis/mailchimp-api/docs/3.0/batch-webhooks/:batch_webhook_id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

batch_webhook_idstring required

The unique id for the batch webhook.

Query parameters

fieldsstring[]

A comma-separated list of fields to return. Reference parameters of sub-objects with dot notation.

exclude_fieldsstring[]

A comma-separated list of fields to exclude. Reference parameters of sub-objects with dot notation.

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.

Example response

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

Changes

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