Skip to main content

Webhook

Webhook​

This page documents how to configure your webhook URL and the format of the notifications sent by the system.

Webhook​

This endpoint allows a user to update their webhook URL.

Endpoint​

  • Path: /webhook
  • Method: POST

Request​

  • Parameters:
    • url: A string representing the new webhook URL.

Response​

  • Fields:
    • message: A confirmation message. On success, returns "ok".

Description​

Send a request with a new url to update the user's webhook endpoint. This allows the system to send future events or notifications to the specified URL.

Webhook Notification Format​

Describes the format of the JSON payload sent to the user's webhook URL when a deposit or withdraw changes state.

Payload Format​

The webhook request body is a JSON object with the following structure:

{
  "id": "string",
  "type": "deposit | withdraw",
  "url": "string",
  "status": "string",
  "update": "string" // optional
}