Business API
Update a webhook
api
patch
/webhooks/{webhook_id}

Update a webhook

Update an existing webhook. Change the URL to which event notifications are sent or the list of event types to be notified about.

You must specify at least one of these two. The fields that you don't specify are not updated.

For more information, see Tutorials: About webhooks and Tutorials: 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. In the Revolut Business app, select the corresponding API certificate.
    2. 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

The new webhook URL for the given webhook

Path Parameters
Path Parameters

The ID of the webhook to update.

Request body
Body object

A valid webhook URL to which to send event notifications. The supported protocol is https.

Possible values: [TransactionCreated, TransactionStateChanged, PayoutLinkCreated, PayoutLinkStateChanged]

A list of event types to subscribe to.

Response

The successfully updated webhook

Response body
Body object

The ID of the webhook.

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

Possible values: [TransactionCreated, TransactionStateChanged, PayoutLinkCreated, PayoutLinkStateChanged]

The list of event types that you are subscribed to.

Was this page helpful?
Loading...