batch-webhooks

List batch webhooks

Get all webhooks that have been configured for batches.

get/3.0/batch-webhooks

Request

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.

countinteger

The number of records to return. Default value is 10. Maximum value is 1000

offsetinteger

Used for pagination, this is the number of records from a collection to skip. Default value is 0.

Response

total_itemsinteger

The total number of items matching the query regardless of pagination.

Example response

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

Changes

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