Business API
Retrieve a list of failed webhook events
api
get
/webhooks/{webhook_id}/failed-events

Retrieve a list of failed webhook events

Get the list of all your failed webhook events, or use the query parameters to filter the results.

The events are sorted by the created_at date in reverse chronological order.

The returned failed events are paginated. The maximum number of events returned per page is specified by the limit parameter. To get to the next page, make a new request and use the created_at date of the last event returned in the previous response.

For more information, see the guides: About webhooks and Manage webhooks.

Access Token​

Each Business API request must contain an authorization header in the following format to make a call: Bearer <your_access_token>.

The access token will be obtained the first time you set up your application and has an expiration of 40 minutes. During setup, a refresh_token will also be obtained which allows to obtain a new access_token.

danger

Never share your client-assertion JWT (JSON web token), access_token and refresh_token with anyone, as these can be used to access your banking data and initiate transactions.

Access tokens can be issued with four security scopes and require a JWT (JSON Web Token) signature to be obtained:

  • READ: Permissions for GET operations.

  • WRITE: Permissions to update counterparties, webhooks, and issue payment drafts.

  • PAY: Permissions to initiate or cancel transactions and currency exchanges.

  • READ_SENSITIVE_CARD_DATA: Permissions to retrieve sensitive card details.

    caution

    If you enable the READ_SENSITIVE_CARD_DATA scope for your access token, you must set up IP whitelisting. Failing to do so will prevent you from accessing any Business API endpoint.

    IP whitelisting means that you must specify an IP or a set of IPs which will be the only IPs from which requests to the API will be accepted. To do so:

    1. Go to the Revolut Business web app settings -> APIs -> Business API.
    2. Select the corresponding API certificate.
    3. In Production IP whitelist, provide the IP(s) which should be whitelisted, and save.

To configure your JWT and obtain the refresh and first access tokens, complete the following steps:

  1. Sign up for a Revolut Business account
  2. Prepare your Sandbox environment
  3. Make your first API request

Request​

Path Parameters
Path Parameters

The ID of the webhook for which to get the failed events.

Query Parameters
Query Parameters

Possible values: >= 1 and <= 1000

Default value: 100

The maximum number of events returned per page.

To get to the next page, make a new request and use the created_at date of the last event returned in the previous response as value for created_before.

Possible values: >= 'created_at' - 21 days

Default value: the date-time at which the request is made

Retrieves events with created_at < created_before. Cannot be older than the current date minus 21 days. The default value is the current date and time at which you are calling the endpoint.

Provided in ISO 8601 format.

Response​

The list of all your existing failed webhook events

Response body
Body array of objects

The ID of the webhook event.

The date and time the event was created in ISO 8601 format.

The date and time the event was last updated in ISO 8601 format.

The ID of the webhook for which the event failed.

The valid webhook URL that event notifications are sent to. The supported protocol is https.

The details of the failed event.

The date and time the last attempt at the event delivery occurred in ISO 8601 format.

Was this page helpful?
Loading...