batch-webhooks

Update batch webhook

Update a webhook that will fire whenever any batch request completes processing.

patch/3.0/batch-webhooks/{batch_webhook_id}

Request

Path parameters

batch_webhook_idstring required

The unique id for the batch webhook.

Request body

enabledboolean

Whether the webhook receives requests or not.

urlstring

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.

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.