Get All Deliveries for a Webhook
Get a list of deliveries for a webhook.
URL
GET https://api-business.apple.com/v1/webhooks/{id}/deliveriesPath Parameters
| Name | Type | Description |
|---|---|---|
id Required | string | The unique identifier for the resource. |
Query Parameters
| Name | Type | Description |
|---|---|---|
filter[deliveryState] Optional | [string] | Filter the deliveries by delivery state. Possible values: |
filter[createdDateTimeAtOrAfter] Optional | [string] | Return only deliveries created at or after this date and time. |
filter[createdDateTimeAtBefore] Optional | [string] | Return only deliveries created before this date and time. |
fields[webhookDeliveries] Optional | [string] | The fields to return for webhook deliveries. |
fields[webhookEvents] Optional | [string] | The fields to return for included webhook events. |
limit Optional | integer | The number of resources to return. |
cursor Optional | string | An opaque cursor value that you use to retrieve the next page of results. |
include Optional | [string] | Related resources to include in the response. Possible value: |
Response Codes
| Status | Reason | Type | Description |
|---|---|---|---|
| 200 | OK Content-Type: application/json | WebhookDeliveriesResponse | |
| 400 | Bad Request Content-Type: application/json | ErrorResponse | An error occurred with your request. |
| 401 | Unauthorized Content-Type: application/json | ErrorResponse | |
| 403 | Forbidden Content-Type: application/json | ErrorResponse | Request not authorized. |
| 404 | Not Found Content-Type: application/json | ErrorResponse | |
| 429 | Content-Type: application/json | ErrorResponse | Too Many Requests |