Retrieve information about an account webhook

Introduction

This guide provides a detailed walkthrough on retrieving information about a webhook associated with an account. Following these steps, you'll be equipped to retrieve details of a previously created webhook for an account.

:warning: Please note that you can only retrieve information about your created webhooks. If you haven't set up any webhooks for an 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.

Call the 'retrieve information' webhook endpoint

Once your authorisation token is ready, call the 'retrieve information about an account' webhook endpoint provided by Overledger's API. This endpoint enables you to retrieve details of a specific webhook associated with an account. Specify the webhookId you obtained when setting up the webhook.

Refer to our API reference documentation under Manage webhooks for account updates for detailed information about this endpoint.

Following these steps, you'll seamlessly retrieve information about an account's webhook, gaining insights into its configuration.