BYbyaccrue
WebhookEvents

List Webhook Events

get/api/v1/webhook-events

Request

Query parameters

filter[since]string

Filter webhook events at or after the provided date

Example:2021-01-01T00:00:00Z
filter[until]string

Filter webhook events at or before the provided date

Example:2021-01-01T00:00:00Z
filter[topic]string

Comma-separated list of webhook topics to return. Unknown topics, and the * wildcard, are rejected with 400. Events are only recorded for topics one of your webhooks is subscribed to.

Example:CounterpartyTransactionCreated,CounterpartyTransactionUpdated
page[limit]number

Maximum number of objects that will be returned. Can not be greater than 50.

page[offset]number

Offset from the beginning of the list of objects. Can not be negative.

Headers

Client-IDstring uuid required

The unique identifier of the client making the request. This header is required to retrieve the client-specific configuration and ensure that the response is tailored to the client's settings and permissions.

Example:123e4567-e89b-12d3-a456-426614174000
Authorizationstring uuid required

Secure secret to access privileged endpoints.

Example:Bearer 633b336e4f57f095a405f6685e208cc7dd16de3e82494662f2acfeec3af1cdef

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "userId": "123e4567-e89b-12d3-a456-426614174000",
        "walletId": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  ],
  "included": [
    {
      "attributes": {
        "charges": {
          "fee": {
            "amount": 59,
            "type": "pay_by_wallet_refund"
          }
        },
        "deductions": {
          "fees": 59
        }
      }
    }
  ]
}

Changes

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