POpolar
webhooks
public

List Webhook Deliveries

Changed on

List webhook deliveries.

Deliveries are all the attempts to deliver a webhook event to an endpoint.

Scopes: webhooks:read webhooks:write

get/v1/webhooks/deliveries

Request

  • Base URL
    https://api.polar.sh
  • URL
    https://api.polar.sh/v1/webhooks/deliveries
  • Auth
    • OpenID Connect (/.well-known/openid-configuration, scopes: webhooks:read, webhooks:write)
    • or HTTP bearer
    • or HTTP bearer

Query parameters

string uuid4
OR
string[]
start_timestampstring date-time nullable

Filter deliveries after this timestamp.

end_timestampstring date-time nullable

Filter deliveries before this timestamp.

succeededboolean nullable

Filter by delivery success status.

querystring nullable

Query to filter webhook deliveries.

http_code_class'2xx' | '3xx' | '4xx' | '5xx' nullable

Filter by HTTP response code class (2xx, 3xx, 4xx, 5xx).

'checkout.created' | 'checkout.updated' | 'checkout.expired' | 'customer.created' | 'customer.updated' | 'customer.deleted' | 'customer.state_changed' | 'customer_seat.assigned' | 'customer_seat.claimed' | 'customer_seat.revoked' | 'member.created' | 'member.updated' | 'member.deleted' | 'order.created' | 'order.updated' | 'order.paid' | 'order.refunded' | 'subscription.created' | 'subscription.updated' | 'subscription.active' | 'subscription.canceled' | 'subscription.uncanceled' | 'subscription.cycled' | 'subscription.revoked' | 'subscription.past_due' | 'subscription.paused' | 'subscription.resumed' | 'refund.created' | 'refund.updated' | 'product.created' | 'product.updated' | 'discount.created' | 'discount.updated' | 'discount.deleted' | 'benefit.created' | 'benefit.updated' | 'benefit_grant.created' | 'benefit_grant.cycled' | 'benefit_grant.updated' | 'benefit_grant.revoked' | 'organization.updated'
OR
WebhookEventType[]
pageinteger

Page number, defaults to 1.

limitinteger

Size of a page, defaults to 10. Maximum is 100.

Response

Successful Response

Changes

  • 2bc8253676a5Revision changes
    • warning

      added the new discount.created enum value to the /// response property for the response status

    • warning

      added the new discount.deleted enum value to the /// response property for the response status

    • warning

      added the new discount.updated enum value to the /// response property for the response status

    • warning

      added the new subscription.cycled enum value to the /// response property for the response status

    • info

      added the enum value discount.created to the property anyOf[subschema #1: WebhookEventType]/ of the query request parameter event_type

    • info

      added the enum value discount.created to the property anyOf[subschema #2]/items/ of the query request parameter event_type

    • info

      added the enum value discount.deleted to the property anyOf[subschema #1: WebhookEventType]/ of the query request parameter event_type

    • info

      added the enum value discount.deleted to the property anyOf[subschema #2]/items/ of the query request parameter event_type

    • info

      added the enum value discount.updated to the property anyOf[subschema #1: WebhookEventType]/ of the query request parameter event_type

    • info

      added the enum value discount.updated to the property anyOf[subschema #2]/items/ of the query request parameter event_type

    • info

      added the enum value subscription.cycled to the property anyOf[subschema #1: WebhookEventType]/ of the query request parameter event_type

    • info

      added the enum value subscription.cycled to the property anyOf[subschema #2]/items/ of the query request parameter event_type