Contents

Get All Deliveries for a Webhook

Get a list of deliveries for a webhook.

URL

GET https://api-business.apple.com/v1/webhooks/{id}/deliveries

Path Parameters

NameTypeDescription
id Requiredstring

The unique identifier for the resource.

Query Parameters

NameTypeDescription
filter[deliveryState] Optional[string]

Filter the deliveries by delivery state. Possible values: SUCCEEDED, FAILED, PENDING.

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 Optionalinteger

The number of resources to return.

cursor Optionalstring

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: event.

Response Codes

StatusReasonTypeDescription
200OK
Content-Type: application/json
WebhookDeliveriesResponse

400Bad Request
Content-Type: application/json
ErrorResponse

An error occurred with your request.

401Unauthorized
Content-Type: application/json
ErrorResponse

403Forbidden
Content-Type: application/json
ErrorResponse

Request not authorized.

404Not Found
Content-Type: application/json
ErrorResponse

429
Content-Type: application/json
ErrorResponse

Too Many Requests

Mentioned in

Topics

Responses

See Also

Webhooks