Webhooks

Receive notifications when an order or settlement changes the status.

Setting up Webhooks

Webhooks must be set in the Integration page of Beta's Dashboard.

Webhook Events:

• Order.created

• Order.confirmed

• Order.cancelled

• Settlement.created

• Settlement.confirmed

• Settlement.cancelled

Webhook example:

For Orders:

order.created, order.confirmed and order cancelled:
{
 "id": "callback_uuid",
 "event": "order.confirmed",
 "account_id": "string",
 "data": {
  "order_id": "string",
  "created_at": "string",
  "updated_at": "string",
  "description": "string",
  "recipient_email": "string",
  "status": "string",
  "target_amount": 0,
  "target_asset": "string",
  "valid_until": "string",
  "message": "string",
 }
}

For Settlement:

settlement.created, settlement.confirmed and settlement.cancelled:
{
  "id": "callback_uuid",
  "event": "settlement.confirmed",
  "account_id": "string",
  "data": {
    "settlement_id": "string",
    "comments": "string",
    "created_at": "string",
    "processed_at": "string",
    "updated_at": "string",
    "external_hash": "string",
    "message": "string",
    "number_of_orders_associated": 0,
    "status": "string",
    "target_amount": 0,
    "target_asset": "string",
    "target_asset_network": "string"
  }
}