Webhooks
Description
The endpoints allow you to manage your configuration of Webhooks receivable from the Send platform.
How to add a webhook
To receive notifications on the update events you should provide the following:
- URL link - That URL will receive the events from the Send API
- Events - an array of the events that the URL will receive the updates for
- Description - Text description for the Webhook
List of currently available events:
| Event | Description |
|---|---|
| account_updated | Allows tracking of the Account status during Account creation and updates. |
| wallet_updated | Allows tracking of the Wallet status during Wallet creation process and then the Wallet Balance. |
| payin_address_updated | Allows tracking of the PayIn Address status during the PayIn Address creation |
| payin_transaction_created | A new PayIn Transaction has been created within the system for a PayIn Address |
| payin_transaction_updated | Allows tracking of the PayIn Transaction after you create one for your PayIn Address |
| trade_transaction_updated | Allows tracking of the Trade Transaction status after you create a Trade |
| transfer_transaction_updated | Allows tracking of the Transfer Transaction status after you create a Transfer |
| payout_transaction_updated | Allows tracking of the Payout Transaction status after you create a Payout |
| payment_address_updated | Allows tracking of the Payment Address status during the Recipient creation process or after adding the Payment Address as a separate request. |
| recipient_updated | Allows tracking of the Recipient status during the Recipient creation process |
| all_default_events | If all_default_events is specified then all events that are enabled by default will be sent to the provided URL. If you have all_default_event active and Send adds a new event this new event will be automatically included in all_default_event. |
Request example for POST /webhooks
{
"url": "https://www.testtest123456666.com/apievents1",
"events": [
"account_registration_status_updated",
"authorised_representative_status_updated",
"wallet_status_updated",
"deposit_address_status_updated",
"deposit_transaction_created",
"deposit_transaction_status_updated",
"trade_transaction_status_updated",
"payment_transaction_updated"
],
"description": "Primary webhook target"
}In response to your request you will receive either a SUCCESS 201 response or one or the error responses (400, 401, 500) See Status Codes & Error Messages.
Within the response you will receive all the data you’ve provided with the webhookId
to refer to the Webhook as well as createdAt and updatedAt dates and Webhook status.
Response example for POST /webhooks
{
"item": {
"webhookId": "string",
"url": "https://www.testtest123456666.com/apievents1",
"events": [
"account_registration_status_updated",
"authorised_representative_status_updated",
"wallet_status_updated",
"deposit_address_status_updated",
"deposit_transaction_created",
"deposit_transaction_status_updated",
"trade_transaction_status_updated",
"payment_transaction_updated"
],
"description": "Primary webhook target",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"status": "active"
}
}Not Seeing What You're Looking For?
We are always looking to improve our API documentation to ensure Sends systems are easy to understand and quick to build against. If you're struggling to find the answer to a question we either haven't made it easy enough to find the relevant docs or we haven't had a chance to write something up for it yet.
Either way we want to hear from you!
Head over to our Discussion Board and leave us a note. We keep a close eye on this and want to ensure we make these docs as useful as they can be so will jump on any posts quickly.
Updated 22 days ago