Update the callback URL for an account webhook

Introduction

This guide provides a detailed walkthrough on updating the callback URL of a webhook associated with an account. By following these steps, you'll be equipped to modify the callback URL of a previously created webhook for your account.

:warning: Please note that you can only update the webhooks you have created. If you haven't set up any webhooks for your account yet, please refer to the documentation on Set a webhook for an Account for more information

Prerequisites

  • Obtain an authorization token
    You must obtain an authorisation token to interact with Overledger's API and call any endpoint. This token will authenticate your requests and grant you access to the necessary endpoints. Please follow the authentication process provided by Overledger to get your authorisation token.
  • Setup a new callback URL

Call the update callback URL for an account webhooks endpoint

This endpoint allows you to update the callback URL associated with a specific webhook for your account.

  • Specify the webhookId you are trying to update in the endpoint path

https://api.sandbox.overledger.io/api/webhooks/accounts/{webhookId}

  • Send the new callbackUrl to Overledger
curl --request PATCH \
     --url https://api.sandbox.overledger.io/api/webhooks/accounts/webhookId \
     --header 'API-Version: 3.0.0' \
     --header 'Authorization: Bearer token' \
     --header 'accept: application/json' \
     --header 'content-type: application/json'
     --data '
{
  "callbackUrl": "https://www.example.com"
}
'

You can seamlessly update the callback URL for your account webhook, ensuring that you receive notifications at the correct endpoint and stay informed about relevant events and actions within your system.