Vault event created

An entry has been appended to the vault balance ledger: an incoming transfer was detected, quarantined funds were released, or an outgoing transfer was initiated, confirmed, aborted, rejected or failed (see the kind field of the vault event)

WEBHOOK vault.event.created

Example

{
  "id": "whe-544ul-uqgad-jkgltj5p6fvd04cj",
  "date": "2023-04-14T20:41:28.715Z",
  "timestampSent": 1719566994,
  "deliveryAttempt": 1,
  "kind": "vault.event.created",
  "data": {
    "vaultEvent": "<unknown>"
  },
  "retryOf": "whe-544ul-uqgad-jkgltj5p6fvd04cj"
}

Body

application/json

id · string · required

Unique identifier for this webhook event.

Required string length: 1 - 64

Pattern: ^whe-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Example:

"whe-544ul-uqgad-jkgltj5p6fvd04cj"

date · string<date-time> · required

ISO 8601 date (must be UTC). Timestamp when the event occurred.

Example:

"2023-04-14T20:41:28.715Z"

timestampSent · integer · required

Unix timestamp when the event was sent

Example:

1719566994

deliveryAttempt · integer · required

Delivery attempt number

Required range: x >= 1

Example:

1

kind · enum<string> · required

Available options: vault.event.created

data · object · required

Show child attributes

retryOf · string

ID of the original event if this is a retry.

Required string length: 1 - 64

Pattern: ^whe-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$

Example:

"whe-544ul-uqgad-jkgltj5p6fvd04cj"

Response

200

Respond with a 200 to indicate that the event was successfully received. If your endpoint returns anything else than a 200 status code, we will consider the delivery has failed and retry later. See details here.