Webhook Introduction

Overview:

Webhooks allow Ceffu to send real-time notifications to your backend when important events occur (such as deposits or withdrawals). Instead of polling the API for updates, your system will automatically receive push callbacks from Ceffu. Once a webhook endpoint is configured, Ceffu will POST event data to your URL whenever a subscribed event happens. You can then verify the signature and process the event in your system.

How to start with The Webhook?

Webhook Setup Procedure on website

Navigate to Entity Management > Webhook Endpoint Management (after API key management) to set up a webhook endpoint

Click on the "Add Webhook Endpoint" button.

Provide an appropriate name for your webhook endpoint and specify the HTTPS URL.

Select the wallets linked to the webhook and indicate the types of events the webhook should monitor. For Prime Wallet Sub Wallets, please select "All Wallets."

Click on the "Submit" button to create the webhook.

Note:

You can create up to 30 webhooks.

When a new webhook is created, it is disabled by default. Enable it using the toggle switch once your service is ready.

For each event dispatched from the webhook, an HTTP status code 200 is expected to indicate successful delivery. If no response is received, the system will retry, with increasing delays between attempts: 30s, 120s, 480s, 1920s, and 7680s. If all retries fail, Ceffu will mark the delivery status as 'Failed'.

A webhook endpoint will be suspended after 500 failed notifications (this limit resets daily, UTC+0, or each time the webhook is re-enabled). You can manually re-enable it via the user interface to resume message reception.

Any response other than HTTP 200, including no response (“null”), is considered a failure.

There is a "Test" button on the website. Clicking it sends a POST request with empty data to the webhook endpoint. The test is successful if an HTTP 200 OK response is received within 10 seconds; otherwise, it fails. Failures from these tests will not be counted towards the suspension limit.

Decode the data

Content type of response is in application/json
Response Example:

{
   "entityId": "36981140216868864",
   "webhookId": "1788141873578217474",
   "sign": "gawAT2ndVvqfyGmFmQwjHXzCRorHbcxFmz6uE/SUJHLZjmwlqUZNH2t6WiBdRHEuk9fvEREWQwBl5nN6pzsX4Q==",
   "event": "1",
   "timestamp": 1720606148847,
   "data": {
     "orderViewId": "20400454368144883712",
     "txId": null,
     "transferType": 20,
     "direction": 10,
     "fromAddress": "1544594690749788161",
     "toAddress": "1572553622146764801",
     "network": null,
     "coinSymbol": "TRX",
     "amount": "1.33000000000000000000",
     "feeSymbol": null,
     "feeAmount": null,
     "status": 40,
     "confirmedBlockCount": null,
     "maxConfirmBlock": null,
     "unlockConfirm": null,
     "memo": null,
     "txTime": 1720606148703,
     "walletIdStr": "1572553622146764801"
   }
 }

Response structure:

Attributes	Definition
entityId	Institution Id
webhookId	Webhook Id
sign	Signature of response
event	"1" (DEPOSIT_SUCCESS) "2" (DEPOSIT_FAILED) "3" (WITHDRAWAL_SUCCESS) "4" (WITHDRAWAL_FAILED) "5" (DEPOSIT_PENDING, Non-whitelisted From Address) "11" (DELEGATION_SUCCESS) "12" (DELEGATION_FAILED) "13" (UNDELEGATION_SUCCESS) "14" (UNDELEGATION_FAILED)
timestamp	Unix time
data	Detail data of corresponding event

Download Key for checking signature

Code Samples for verifying signature:

Javascript:

Python:

Java:

Overview:#

How to start with The Webhook?#

Code Samples for verifying signature:#

Overview:

How to start with The Webhook?

Code Samples for verifying signature: