ALalternativepayments
Webhooks

List webhook events

Changed on

Get a paginated list of webhook events with optional filtering

get/webhooks/events

Request

  • Base URL
    https://public-api.alternativepayments.io
  • URL
    https://public-api.alternativepayments.io/webhooks/events
  • Auth
    OAuth 2
    Client credentials
    Token URL: /oauth/token scopes: webhooks:read

Query parameters

limitinteger

Number of items to return

afterstring

Cursor for forward pagination

beforestring

Cursor for backward pagination

topic'payout_paid' | 'payout_failed' | 'payout_processing' | 'payout_scheduled' | 'customer_created' | 'customer_updated' | 'customer_archived' | 'payment_succeeded' | 'payment_chargeback' | 'payment_refunded' | 'invoice_paid' | 'invoice_archived' | 'invoice_created' | 'invoice_updated' | 'payment_failed' | 'payment_method_added' | 'payment_method_deleted' | 'default_payment_method_changed'

Filter by webhook topic

status'pending' | 'sent' | 'failed'

Filter by event status

from_datestring

Filter events created after this date (ISO 8601)

to_datestring

Filter events created before this date (ISO 8601)

Response

OK

end_cursorstring
has_next_pageboolean
has_previous_pageboolean
start_cursorstring

Example response

{
  "end_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH",
  "has_next_page": true,
  "start_cursor": "gaFpxBACEaXBVABEYbHG+X9LyLnH"
}

Changes

  • 4e3a31effa3fRevision changes
    • breaking

      removed the enum value bill_created from the query request parameter topic

    • breaking

      removed the enum value bill_deleted from the query request parameter topic

    • breaking

      removed the enum value bill_rejected from the query request parameter topic

    • breaking

      removed the enum value bill_submitted from the query request parameter topic

    • breaking

      removed the enum value bill_updated from the query request parameter topic

    • breaking

      removed the enum value vendor_created from the query request parameter topic

    • breaking

      removed the enum value vendor_data_request_submitted from the query request parameter topic

    • breaking

      removed the enum value vendor_deactivated from the query request parameter topic

    • breaking

      removed the enum value vendor_payment_canceled from the query request parameter topic

    • breaking

      removed the enum value vendor_payment_failed from the query request parameter topic

    • breaking

      removed the enum value vendor_payment_processing from the query request parameter topic

    • breaking

      removed the enum value vendor_payment_succeeded from the query request parameter topic

    • breaking

      removed the enum value vendor_reactivated from the query request parameter topic

    • breaking

      removed the enum value vendor_updated from the query request parameter topic

    • info

      removed the bill_created enum value from the // response property for the response status

    • info

      removed the bill_deleted enum value from the // response property for the response status

    • info

      removed the bill_rejected enum value from the // response property for the response status

    • info

      removed the bill_submitted enum value from the // response property for the response status

    • info

      removed the bill_updated enum value from the // response property for the response status

    • info

      removed the vendor_created enum value from the // response property for the response status

    • info

      removed the vendor_data_request_submitted enum value from the // response property for the response status

    • info

      removed the vendor_deactivated enum value from the // response property for the response status

    • info

      removed the vendor_payment_canceled enum value from the // response property for the response status

    • info

      removed the vendor_payment_failed enum value from the // response property for the response status

    • info

      removed the vendor_payment_processing enum value from the // response property for the response status

    • info

      removed the vendor_payment_succeeded enum value from the // response property for the response status

    • info

      removed the vendor_reactivated enum value from the // response property for the response status

    • info

      removed the vendor_updated enum value from the // response property for the response status