Released: 20 June 2023
What’s new
We are launching a new version of Overledger Webhook APIs. Version 3 APIs are even more robust, clear, and easy to use. These APIs will allow Overledger users to monitor events on the blockchain and receive updates to a callback URL when an event occurs on their address or smart contract ID.
How you can benefit
The following APIs provide the ability to create a webhook for an account or smart contract event and receive notifications each time a transaction happens on a blockchain account or when an event occurs on a smart contract.
Create a Webhook for an account
Supported networks: Ethereum, Bitcoin, XRP Ledger, and Polkadot.
Sandbox
API: POST https://api.sandbox.overledger.io/webhooks/accounts
Production
API: POST https://api.overledger.io/webhooks/accounts
API Documentation can be found here
Create a Webhook for a Smart contract event
Supported networks: Ethereum networks: Goerli, XDC, Polygon, and Avalanche.
Sandbox
API: POST https://api.sandbox.overledger.io/webhooks/smart-contract-events
Production
API: POST https://api.overledger.io/webhooks/smart-contract-events
API Documentation can be found here
Update the CallbackURL for an Account Webhook
This API provides will give users the ability to update the callback URL used for an account webhook.
Sandbox
API: POST https://api.sandbox.overledger.io/webhooks/accounts/{webhookid}
Production
API: POST https://api.overledger.io/webhooks/accounts/{webhookid}
API Documentation can be found here
Update the CallbackURL for a Smart Contract Event Webhook
This API will give users the ability to update the callback URL used for a smart contract event webhook.
Sandbox
API: POST https://api.sandbox.overledger.io/webhooks/smart-contract-events/{webhookid}
Production
API: POST https://api.overledger.io/webhooks/smart-contract-events/{webhookid}
API Documentation can be found here
The following APIs provide the ability to retrieve information about webhooks that are set up for a user’s application:
Retrieve a list of Webhooks for Accounts
Sandbox
API: POST https://api.sandbox.overledger.io/webhooks/accounts/
Production
API: POST https://api.overledger.io/webhooks/accounts/
API Documentation can be found here
Retrieve a list of Webhooks for Smart Contract Events
Sandbox
API: POST https://api.sandbox.overledger.io/webhooks/smart-contract-events/
Production
API: POST https://api.overledger.io/webhooks/smart-contract-events/
API Documentation can be found here
Retrieve information for an Account Webhook
Sandbox
API: POST https://api.sandbox.overledger.io/webhooks/accounts/{webhookid}
Production
API: POST https://api.overledger.io/webhooks/accounts/{webhookid}
API Documentation can be found here
Retrieve information for a Smart Contract Event
Sandbox
API: POST https://api.sandbox.overledger.io/webhooks/smart-contract-events/{webhookid}
Production
API: POST https://api.overledger.io/webhooks/smart-contract-events/{webhookid}
API Documentation can be found here
If customers need to stop receiving notifications, it is possible to stop webhooks using the following APIs:
Delete an Account Webhook
Sandbox
API: POST https://api.sandbox.overledger.io/webhooks/accounts/{webhookId}
Production
API: POST https://api.overledger.io/webhooks/accounts/{webhookId}
API Documentation can be found here
Delete a Smart Contract Event Webhook
Sandbox
API: POST https://api.sandbox.overledger.io/webhooks/smart-contract-events/{webhookId}
Production
API: POST https://api.overledger.io/webhooks/smart-contract-events/{webhookId}
API Documentation can be found here