Hook Structure

Delos webhooks contain a typed structure consisting of main fields and objects depending on the type of webhook

Example

{
  //Unique Event ID (uuid4)
  "hook_id" : "string",
  //Webhook Type
  "hook_type" : int,
  "Data" : {
    // Object by webhook type
    // "Operation" : {}
    // or
    // "Client" : {}
    // or
    // "Account" : {}
    // or
    // "Counterparty" : {}
  }
}

Webhook Types

Field hook_type is string value:

• 1 = OPERATION - Webhook contains Operation object
• 2 = DEPOSIT_ACCOUNT - Webhook contains Deposit Account object
• 3 = CLIENT - Webhook contains customer object
• 4 = COUNTERPARTY - Webhook contains Counterparty (Beneficiar) object
• 5 = DEPOSIT_ACCOUNT_REQUISITE - Webhook contains Deposit Account object (Raised if requisites is changed)

Webhooks are sent whenever the status or state of the corresponding object changes.

Example webhook body (Operation):

{
  "hook_id": "f1c37cdc-1c64-466c-bd3f-306c000e6b36",
  "hook_type": 1,
  "Data": {
    "Operation": {
      "cuid": "DnuQu6n-dP25-YKJ78eiuzL",
      "opid": "977d614e-6ca8-492e-97b5-9e7f0f73d86c",
      "type": 3,
      "source": {
        "account": "U1v72kDJdQw"
      },
      "status": 1,
      "created_at": {
        "seconds": 1734589267
      },
      "is_visible": true,
      "updated_at": {
        "nanos": 221000000,
        "seconds": 1734589267
      },
      "destination": {
        "beneficiar": "U6OFFpEoEdHA"
      },
      "payment_type": 3,
      "source_amount": {
        "sum": {
          "nanos": 200000000,
          "units": 123,
          "currency_code": "USD"
        },
        "default": {
          "nanos": 200000000,
          "units": 123,
          "currency_code": "USD"
        }
      },
      "commission_amount": {
        "sum": {
          "currency_code": "USD"
        },
        "default": {
          "currency_code": "USD"
        }
      },
      "destination_amount": {
        "sum": {
          "nanos": 200000000,
          "units": 123,
          "currency_code": "USD"
        },
        "default": {
          "nanos": 200000000,
          "units": 123,
          "currency_code": "USD"
        }
      },
      "current_balance_amount": {
        "sum": {
          "units": 295,
          "currency_code": "USD"
        },
        "default": {
          "units": 295,
          "currency_code": "USD"
        }
      }
    }
  }
}