Events via web-hooks

Stay informed about events related to accounts, groups, requests, transactions, users, or whitelists by subscribing to web-hooks. Configure notifications using the following example:

Bash

curl --request PUT \
  --url https://api.vault.ledger.com/notifications/configuration \
  --header 'authorization: Bearer {{access_token}}' \
  --header 'content-type: application/json' \
  --header 'x-ledger-workspace: minivault' \
  --data '{
    "all": {
      "webhook": {
        "secret": "secret", 
        "url": "{{notification_endpoint}}"
      }
    }
  }

JSON

With notification_endpoint a valid HTTPS endpoint that accepts POST queries with the payload similar too:

{
  "payload_type": "TRANSACTION",
  "event_type": "NEW_TRANSACTION_HAS_BEEN_RECEIVED",
  "id": 260
}

For more details on how to use this endpoint please refer to the API documentation.

Replace {{notification_endpoint}} with a valid HTTPS endpoint that accepts POST queries. You'll receive notifications similar to the following payload:

{
  "payload_type": "TRANSACTION",
  "event_type": "NEW_TRANSACTION_HAS_BEEN_RECEIVED",
  "id": 260
}