Webhook events - NodeAsset

The engine posts each control event to every webhook that names its type, or that names none, and GET /v1/events holds the same events. A webhook is created with POST /v1/webhooks, under four eyes.

Verify a delivery

Header	What it carries
`X-NodeAsset-Signature`	`sha256=` and the hex HMAC-SHA256 of `<X-NodeAsset-Timestamp>.<body>` under the webhook’s secret; compare it in constant time.
`X-NodeAsset-Timestamp`	The delivery’s time in seconds since the epoch, inside the signed text; refuse one far from your own clock.
`X-NodeAsset-Event`	The event’s type, as the body’s `type`.
`X-NodeAsset-Delivery`	The delivery’s id; the same delivery can arrive more than once, with the same id.

Answer 2xx to take a delivery. Any other answer, or none, is retried with backoff until the webhook’s attempts run out. Verify a delivery works one through.

Events

Events: reconciliation.run · reconciliation.finding · reconciliation.hold · hold.released · statement.received · statement.overdue · distribution.payable · distribution.held · distribution.paid · holder.restricted · holder.unrestricted · holder.forced-transfer · holder.recovered · instrument.paused · distribution.rate-changed · distribution.carried · distribution.due · standing-approval.granted · standing-approval.revoked · reserve.minted · reserve.redeemed · reserve.cover-low · reserve.reported · reserve.amended · retention.pruned · operation.succeeded · operation.failed · approval.requested · approval.signed · approval.approved · approval.rejected · subscription.priced · subscription.delivered · subscription.ended · redemption.priced · redemption.funded · redemption.burned · redemption.settled · redemption.withdrawn · dealing-cycle.settled · dealing-cycle.released.

`reconciliation.run`

Announces that a reconciliation run finished, with its verdict and how many findings it made.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`resourceKind`	The kind of record it concerns.
`resourceId`	The run’s id.
`payload`	The event’s own fields.
`payload.reconciliationRunId`	The reconciliation run’s id.
`payload.trigger`	What started the run.
`payload.offset`	The ledger offset the run read at.
`payload.verdict`	What the run found.
`payload.findingCount`	How many findings the run made.

`reconciliation.finding`

Announces that a reconciliation run made findings, with how many per check.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`resourceKind`	The kind of record it concerns.
`resourceId`	The run’s id.
`payload`	The event’s own fields.
`payload.reconciliationRunId`	The reconciliation run’s id.
`payload.findingCount`	How many findings the run made.
`payload.findingsByCheck`	Each check that found something, with how many findings it made.

`reconciliation.hold`

Announces that reconciliation held an instrument on a blocking finding. The instrument is not distributed until the hold is released.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The instrument’s id.
`payload`	The event’s own fields.
`payload.holdId`	The hold’s id.
`payload.reconciliationRunId`	The reconciliation run’s id.
`payload.check`	The check whose findings opened the hold.
`payload.detail`	The findings’ reasons, and how many there were.

`hold.released`

Announces that an instrument hold was released, under two approvers besides the maker.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The hold’s id.
`payload`	The event’s own fields.
`payload.holdId`	The hold’s id.
`payload.check`	The check that opened the hold.
`payload.operationId`	The release’s operation.
`payload.rationale`	The release’s rationale; a webhook may leave it out, and the feed keeps it.

`statement.received`

Announces that an external statement arrived and was stored, the first time these bytes came from this source.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns, where the statement names one.
`resourceKind`	The kind of record it concerns.
`resourceId`	The statement’s id.
`payload`	The event’s own fields.
`payload.externalStatementId`	The external statement’s id.
`payload.externalSourceId`	The external source’s id.
`payload.kind`	What the statement states.
`payload.businessDate`	The business date, `yyyy-MM-dd`, in the source’s zone.
`payload.lines`	How many lines the statement carries.
`payload.receivedBy`	Who posted it; a webhook may leave it out, and the feed keeps it.

`statement.overdue`

Announces that a source’s statement is overdue, newly since the previous reconciliation run.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The source’s id.
`payload`	The event’s own fields.
`payload.externalSourceId`	The external source’s id.
`payload.reconciliationRunId`	The reconciliation run’s id.

`distribution.payable`

Announces that a distribution became payable: reconciliation found nothing that stops it.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The distribution’s id.
`payload`	The event’s own fields.
`payload.distributionId`	The distribution’s id.
`payload.reconciliationRunId`	The reconciliation run’s id.
`payload.period`	The period distributed, `uuuu-MM`.
`payload.totalGross`	The plan’s gross, every line together.
`payload.totalWithheld`	The plan’s withholding, every line together.
`payload.totalPayout`	The plan’s payout, every line together.

`distribution.held`

Announces that a distribution was held, since its instrument is under a hold.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The distribution’s id.
`payload`	The event’s own fields.
`payload.distributionId`	The distribution’s id.
`payload.reconciliationRunId`	The reconciliation run’s id.

`distribution.paid`

Announces that a distribution was paid: every line the Registrar delivered is rolled.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The distribution’s id.
`payload`	The event’s own fields.
`payload.distributionId`	The distribution’s id.
`payload.lines`	How many lines were rolled.
`payload.period`	The period distributed, `uuuu-MM`.
`payload.totalGross`	The plan’s gross, every line together.
`payload.totalWithheld`	The plan’s withholding, every line together.
`payload.totalPayout`	The plan’s payout, every line together.

`holder.restricted`

Announces that a holder was restricted, or that a recovery carried a restriction to its successor.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The one instrument the restriction covers; absent or null for every instrument.
`resourceKind`	The kind of record it concerns.
`resourceId`	The holder’s id.
`payload`	The event’s own fields.
`payload.holderId`	The holder’s id.
`payload.restrictionId`	The restriction’s id.
`payload.mode`	What the restriction stops.
`payload.reason`	Why, as a code; the rationale stays with the venue’s staff.
`payload.orderCited`	Whether the restriction cites an order; the order stays with the venue’s staff.
`payload.autoReleaseAt`	When the restriction stops applying; null for never.
`payload.carriedFrom`	The restriction a recovery carried across, on the holder it recovered.
`payload.operationId`	The operation that opened the restriction.

`holder.unrestricted`

Announces that a holder’s restriction was lifted, under two approvers.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The one instrument the restriction covered; absent or null for every instrument.
`resourceKind`	The kind of record it concerns.
`resourceId`	The holder’s id.
`payload`	The event’s own fields.
`payload.holderId`	The holder’s id.
`payload.restrictionId`	The restriction’s id.
`payload.mode`	What the restriction stops.
`payload.operationId`	The operation that lifted the restriction.

`holder.forced-transfer`

Announces that a consenting holder’s units moved to an eligible receiver under a cited order, one event per move.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument moved.
`resourceKind`	The kind of record it concerns.
`resourceId`	The id of the holder the units left.
`payload`	The event’s own fields.
`payload.fromHolderId`	The holder the units leave.
`payload.toHolderId`	The receiving holder’s id.
`payload.instrumentId`	The instrument moved.
`payload.units`	The units moved, a decimal in plain notation.
`payload.order`	The cited order’s or evidence’s reference, as the ledger carries it.
`payload.orderDocumentHash`	The SHA-256 of the cited document, 64 lowercase hex digits.
`payload.updateId`	The ledger update that moved the units; null where the move was submitted before and not answered again.
`payload.operationId`	The operation that made the move; reconciliation matches the move against it.

`holder.recovered`

Announces that a consenting holder’s units moved to its registered successor, one event per instrument.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument moved.
`resourceKind`	The kind of record it concerns.
`resourceId`	The id of the holder the units left.
`payload`	The event’s own fields.
`payload.fromHolderId`	The holder the units leave.
`payload.toHolderId`	The receiving holder’s id.
`payload.instrumentId`	The instrument moved.
`payload.units`	The units moved, a decimal in plain notation.
`payload.order`	The cited order’s or evidence’s reference, as the ledger carries it.
`payload.orderDocumentHash`	The SHA-256 of the cited document, 64 lowercase hex digits.
`payload.updateId`	The ledger update that moved the units; null where the move was submitted before and not answered again.
`payload.operationId`	The operation that made the move; reconciliation matches the move against it.

`instrument.paused`

Announces that an instrument was paused: its hold opened.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument paused.
`resourceKind`	The kind of record it concerns.
`resourceId`	The instrument’s id.
`payload`	The event’s own fields.
`payload.instrumentId`	The instrument’s id on the Registry.
`payload.holdId`	The hold’s id.
`payload.operationId`	The pause’s operation.
`payload.rationale`	The pause’s rationale; a webhook may leave it out, and the feed keeps it.

`distribution.rate-changed`

Announces that a period whose points carry more than one withholding rate executed at the latest rate, unacknowledged. It fires only where the deployment, and any standing approval, say alert.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The distribution’s id.
`payload`	The event’s own fields.
`payload.distributionId`	The distribution’s id.
`payload.period`	The period, `uuuu-MM`.
`payload.appliedRate`	The withholding rate applied throughout, the latest point’s, as a decimal string.
`payload.rates`	The withholding rate of each point in the period.
`payload.rates[].withholdingRate`	The withholding rate the point carries.
`payload.rates[].asOf`	The point’s instant.
`payload.standingApprovalId`	The standing approval the period was executed under; absent when a person executed it.

`distribution.carried`

Announces that a period executed with the holders whose earlier line is not rolled left out. It fires only where venue.distributions.partial is carry.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The distribution’s id.
`payload`	The event’s own fields.
`payload.distributionId`	The distribution’s id.
`payload.period`	The period, `uuuu-MM`.
`payload.holders`	How many holders the plan left out for a line not rolled; the plan’s `excluded` names them.
`payload.unrolled`	The earlier distributions with a line not rolled.
`payload.unrolled[].distributionId`	The distribution’s id.
`payload.unrolled[].period`	The period, `uuuu-MM`.
`payload.unrolled[].state`	Where the earlier line’s distribution stands.
`payload.unrolled[].lines`	How many of its lines are not rolled.
`payload.standingApprovalId`	The standing approval the period was executed under; absent when a person executed it.

`distribution.due`

Announces that a scheduled record date passed with no distribution of its period. It fires again, with refused, when a standing approval’s operation for the period was refused.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The scheduled distribution: `<instrumentId>/<period>`.
`payload`	The event’s own fields.
`payload.instrumentId`	The instrument’s id on the Registry.
`payload.period`	The period’s label.
`payload.recordDate`	The record date, `yyyy-MM-dd`.
`payload.paymentDate`	The payment date, `yyyy-MM-dd`.
`payload.standingApprovalId`	The live standing approval the scheduler executes the period under; with `refused`, the one whose operation was refused.
`payload.operationId`	With `refused`: the standing approval’s operation for the period.
`payload.refused`	The refusal’s problem slug, or `internal`.

`standing-approval.granted`

Announces that a standing approval was granted; the scheduler executes the instrument’s due distributions under it until it lapses or is revoked.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the standing approval covers.
`resourceKind`	The kind of record it concerns.
`resourceId`	The standing approval’s id.
`payload`	The event’s own fields.
`payload.standingApprovalId`	The standing approval’s id.
`payload.action`	The one action a grant may name.
`payload.validUntil`	When the standing approval lapses.
`payload.maxTotalPayout`	The most one period may pay, in the instrument’s units.
`payload.maxYearlyGrowth`	The most the priced NAV may grow a year from the NAV the period accrues from; 0.1 is 10%.
`payload.rateChange`	Whether a period whose withholding rate changed may execute under the grant.

`standing-approval.revoked`

Announces that a standing approval was revoked, effective at once.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the standing approval covered.
`resourceKind`	The kind of record it concerns.
`resourceId`	The standing approval’s id.
`payload`	The event’s own fields.
`payload.standingApprovalId`	The standing approval’s id.

`reserve.minted`

Announces that a mint against a reserve settled: the deposit locked into the reserve and the backed units minted, in one transaction.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The backed instrument.
`resourceKind`	The kind of record it concerns.
`resourceId`	The mint, as its reserve’s id and its own.
`payload`	The event’s own fields.
`payload.reserveId`	The reserve’s id.
`payload.mintId`	The mint’s id within its reserve.
`payload.assetId`	The asset deposited.
`payload.quantity`	The units of the asset deposited.
`payload.units`	The backed units minted.
`payload.price`	The backed price the ledger judged the mint at.
`payload.updateId`	The transaction that settled it.

`reserve.redeemed`

Announces that a redemption from a reserve settled: the backed units burned and the asset paid, in one transaction.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The backed instrument.
`resourceKind`	The kind of record it concerns.
`resourceId`	The redemption, as its reserve’s id and its own.
`payload`	The event’s own fields.
`payload.reserveId`	The reserve’s id.
`payload.redemptionId`	The redemption’s id within its reserve.
`payload.assetId`	The asset paid.
`payload.units`	The backed units burned.
`payload.quantity`	The units of the asset paid.
`payload.price`	The backed price the ledger judged the redemption at.
`payload.updateId`	The transaction that settled it.

`reserve.cover-low`

Announces that reconciliation found a reserve’s cover below its minimum and held its backed instrument. Mints stop until the hold is released; redemptions go on.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The backed instrument held.
`resourceKind`	The kind of record it concerns.
`resourceId`	The reserve’s id.
`payload`	The event’s own fields.
`payload.reserveId`	The reserve’s id.
`payload.cover`	The cover reconciliation found.
`payload.minCover`	The least cover the terms set.
`payload.reconciliationRunId`	The run that found it.
`payload.holdId`	The hold on the backed instrument, which stops its mints.

`reserve.reported`

Announces that the ledger computed a reserve’s report, on demand or on the reserve’s schedule.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The backed instrument.
`resourceKind`	The kind of record it concerns.
`resourceId`	The reserve’s id.
`payload`	The event’s own fields.
`payload.reserveId`	The reserve’s id.
`payload.reportCid`	The report’s contract.
`payload.version`	The version of the terms it was computed under.
`payload.outstanding`	The backed units outstanding.
`payload.cover`	The cover it found; null with nothing outstanding.

`reserve.amended`

Announces that the issuer accepted new terms for a reserve, which take effect at once or at the time the payload names.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The backed instrument.
`resourceKind`	The kind of record it concerns.
`resourceId`	The amendment, as its reserve’s id and its own.
`payload`	The event’s own fields.
`payload.reserveId`	The reserve’s id.
`payload.amendmentId`	The amendment’s id within its reserve.
`payload.version`	The version the accepted terms became.
`payload.takesEffectAt`	When they take effect.
`payload.loosens`	Whether they loosen the terms, and so wait the reserve’s delay.

`retention.pruned`

Announces that retention deleted records past their retention period, with how many of each.

Field	What it carries
`type`	The event’s type.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`payload`	The event’s own fields.
`payload.reconciliationRuns`	How many reconciliation runs were deleted.
`payload.events`	How many events were deleted.
`payload.outbox`	How many outbox entries were deleted.
`payload.approvals`	How many approval records were deleted.
`payload.operations`	How many operations were deleted.
`payload.idempotencyKeys`	How many idempotency keys were deleted.
`payload.cutoffs`	The cutoffs the pass pruned by.
`payload.cutoffs.reconciliationRuns`	Reconciliation runs started before this instant may be pruned; null keeps every one.
`payload.cutoffs.events`	Events recorded before this instant may be pruned; null keeps every one.
`payload.cutoffs.operations`	Operations finished before this instant may be pruned; null keeps every one.
`payload.cutoffs.approvals`	Approvals decided before this instant may be pruned; null keeps every one.

`operation.succeeded`

Announces that an operation finished succeeded.

Field	What it carries
`type`	The event’s type.
`resourceKind`	The kind of record the operation acted on.
`resourceId`	The id of the record it concerns.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`payload`	The operation, without who acted; `GET /v1/operations/{operationId}` has that.
`payload.operationId`	The operation’s id.
`payload.kind`	What the operation does.
`payload.role`	The role the operation ran under; null for an operation the engine opened itself, whose `actor` names it.
`payload.updateId`	The ledger update the operation committed, where it committed one.

`operation.failed`

Announces that an operation finished failed.

Field	What it carries
`type`	The event’s type.
`resourceKind`	The kind of record the operation acted on.
`resourceId`	The id of the record it concerns.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`payload`	The operation, without who acted; `GET /v1/operations/{operationId}` has that.
`payload.operationId`	The operation’s id.
`payload.kind`	What the operation does.
`payload.check`	The check that refused it, as its problem names it; null where it names none.
`payload.gate`	The gate that refused it, as its problem names it; null where it names none.
`payload.role`	The role the operation ran under; null for an operation the engine opened itself, whose `actor` names it.
`payload.updateId`	The ledger update the operation committed, where it committed one.
`payload.problem`	The problem, cut to what names no holder; the operation’s own read has the rest.
`payload.problem.type`	`urn:nodeasset:problem:<slug>`.
`payload.problem.title`	A short, fixed summary of the problem’s type.
`payload.problem.status`	The HTTP status.

`approval.requested`

Announces that a four-eyes action was recorded on its maker’s call, and awaits an approver.

Field	What it carries
`type`	The event’s type.
`resourceKind`	The kind of record the action acts on.
`resourceId`	The id of the record it concerns.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`payload`	The action, without its maker, checker or reason; `GET /v1/approvals/{actionKey}` has those.
`payload.actionKey`	The four-eyes action’s key.
`payload.kind`	The operation kind the action runs as.
`payload.makerRole`	The role the maker acted in.
`payload.state`	The action’s state.
`payload.operationId`	The operation the approved action ran as.

`approval.signed`

Announces that an approver signed an action that needs two, which awaits the next.

Field	What it carries
`type`	The event’s type.
`resourceKind`	The kind of record the action acts on.
`resourceId`	The id of the record it concerns.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`payload`	The action, without its maker, checker or reason; `GET /v1/approvals/{actionKey}` has those.
`payload.actionKey`	The four-eyes action’s key.
`payload.kind`	The operation kind the action runs as.
`payload.makerRole`	The role the maker acted in.
`payload.state`	The action’s state.
`payload.operationId`	The operation the approved action ran as.

`approval.approved`

Announces that a four-eyes action was approved, and ran.

Field	What it carries
`type`	The event’s type.
`resourceKind`	The kind of record the action acts on.
`resourceId`	The id of the record it concerns.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`payload`	The action, without its maker, checker or reason; `GET /v1/approvals/{actionKey}` has those.
`payload.actionKey`	The four-eyes action’s key.
`payload.kind`	The operation kind the action runs as.
`payload.makerRole`	The role the maker acted in.
`payload.state`	The action’s state.
`payload.operationId`	The operation the approved action ran as.

`approval.rejected`

Announces that a four-eyes action was rejected by an approver, or withdrawn by its maker.

Field	What it carries
`type`	The event’s type.
`resourceKind`	The kind of record the action acts on.
`resourceId`	The id of the record it concerns.
`at`	When the engine announced it.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`payload`	The action, without its maker, checker or reason; `GET /v1/approvals/{actionKey}` has those.
`payload.actionKey`	The four-eyes action’s key.
`payload.kind`	The operation kind the action runs as.
`payload.makerRole`	The role the maker acted in.
`payload.state`	The action’s state.
`payload.operationId`	The operation the approved action ran as.

`subscription.priced`

Announces that a subscription’s attestors priced it, the moment its lot was created on the ledger.

Field	What it carries
`type`	The event’s type.
`at`	The ledger time of the transaction it announces.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The subscription’s id.
`payload`	The subscription as it was priced.
`payload.subscriptionId`	The subscription’s id.
`payload.instrumentId`	The instrument’s id on the Registry.
`payload.holderId`	The registered holder whose party the order or settlement names; null when none does.
`payload.units`	The units of the instrument.
`payload.appliedNav`	The NAV the attestors fixed.
`payload.claimedAt`	When it was claimed.
`payload.contractId`	The lot’s contract.
`payload.amount`	What the order pays or is paid in the payment asset; null when it is paid off the ledger.
`payload.paymentInstrumentId`	The payment asset’s id; null when the order is paid off the ledger.
`payload.updateId`	The ledger update of the transaction it announces; null where the projection holds none for it.

`subscription.delivered`

Announces that a subscription was delivered, its units minted to the holder: the order’s value date.

Field	What it carries
`type`	The event’s type.
`at`	The ledger time of the transaction it announces.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The subscription’s id.
`payload`	The subscription as it was delivered.
`payload.subscriptionId`	The subscription’s id.
`payload.instrumentId`	The instrument’s id on the Registry.
`payload.holderId`	The registered holder whose party the order or settlement names; null when none does.
`payload.units`	The units of the instrument.
`payload.appliedNav`	The NAV the attestors fixed.
`payload.deliveredIn`	The Registry mint’s reference, or the subscription’s own id when its settlement against the payment asset delivered it.
`payload.contractId`	The delivered lot’s contract.
`payload.dealingCycleId`	The dealing cycle whose settle delivered it; null when it settled alone.
`payload.amount`	What the order pays or is paid in the payment asset; null when it is paid off the ledger.
`payload.paymentInstrumentId`	The payment asset’s id; null when the order is paid off the ledger.
`payload.updateId`	The ledger update of the transaction it announces; null where the projection holds none for it.

`subscription.ended`

Announces that a subscription ended: its lot closed, or its claim was withdrawn before it was priced.

Field	What it carries
`type`	The event’s type.
`at`	The ledger time of the transaction it announces.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The subscription’s id.
`payload`	The subscription as it ended.
`payload.subscriptionId`	The subscription’s id.
`payload.instrumentId`	The instrument’s id on the Registry.
`payload.holderId`	The registered holder whose party the order or settlement names; null when none does.
`payload.units`	The units of the instrument.
`payload.state`	How it ended.
`payload.updateId`	The ledger update of the transaction it announces; null where the projection holds none for it.

`redemption.priced`

Announces that the fund’s oracle priced a redemption claim.

Field	What it carries
`type`	The event’s type.
`at`	The ledger time of the transaction it announces.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The redemption’s id.
`payload`	The redemption as it was priced.
`payload.redemptionId`	The redemption’s id.
`payload.instrumentId`	The instrument’s id on the Registry.
`payload.holderId`	The registered holder whose party the order or settlement names; null when none does.
`payload.units`	The units of the instrument.
`payload.nav`	The NAV the oracle priced the claim at.
`payload.asOf`	The dealing point it priced the claim at.
`payload.contractId`	The oracle’s price contract.
`payload.amount`	What the order pays or is paid in the payment asset; null when it is paid off the ledger.
`payload.paymentInstrumentId`	The payment asset’s id; null when the order is paid off the ledger.
`payload.updateId`	The ledger update of the transaction it announces; null where the projection holds none for it.

`redemption.funded`

Announces that the holder’s custodian requested the burn of a redemption’s units.

Field	What it carries
`type`	The event’s type.
`at`	The ledger time of the transaction it announces.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The redemption’s id.
`payload`	The redemption as it was funded.
`payload.redemptionId`	The redemption’s id.
`payload.instrumentId`	The instrument’s id on the Registry.
`payload.holderId`	The registered holder whose party the order or settlement names; null when none does.
`payload.units`	The units of the instrument.
`payload.burnRequestCid`	The burn request’s contract.
`payload.updateId`	The ledger update of the transaction it announces; null where the projection holds none for it.

`redemption.burned`

Announces that the Registrar accepted a redemption’s burn request and burned its units.

Field	What it carries
`type`	The event’s type.
`at`	The ledger time of the transaction it announces.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The redemption’s id.
`payload`	The redemption as it was burned.
`payload.redemptionId`	The redemption’s id.
`payload.instrumentId`	The instrument’s id on the Registry.
`payload.holderId`	The registered holder whose party the order or settlement names; null when none does.
`payload.units`	The units of the instrument.
`payload.burnRequestCid`	The burn request’s contract.
`payload.updateId`	The ledger update of the transaction it announces; null where the projection holds none for it.

`redemption.settled`

Announces that the venue settled a redemption: the order’s value date.

Field	What it carries
`type`	The event’s type.
`at`	The ledger time of the transaction it announces.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The redemption’s id.
`payload`	The redemption as it settled.
`payload.redemptionId`	The redemption’s id.
`payload.instrumentId`	The instrument’s id on the Registry.
`payload.holderId`	The registered holder whose party the order or settlement names; null when none does.
`payload.units`	The units of the instrument.
`payload.burnedIn`	The burn request its settlement named, or the redemption’s own id when it settled against the payment asset.
`payload.dealingCycleId`	The dealing cycle whose settle settled it; null when it settled alone.
`payload.updateId`	The ledger update of the transaction it announces; null where the projection holds none for it.

`redemption.withdrawn`

Announces that the venue withdrew a redemption claim before it settled.

Field	What it carries
`type`	The event’s type.
`at`	The ledger time of the transaction it announces.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The redemption’s id.
`payload`	The redemption as it was withdrawn.
`payload.redemptionId`	The redemption’s id.
`payload.instrumentId`	The instrument’s id on the Registry.
`payload.holderId`	The registered holder whose party the order or settlement names; null when none does.
`payload.units`	The units of the instrument.
`payload.updateId`	The ledger update of the transaction it announces; null where the projection holds none for it.

`dealing-cycle.settled`

Announces that a dealing cycle settled its orders in one transaction, with the fund’s net.

Field	What it carries
`type`	The event’s type.
`at`	The ledger time of the transaction it announces.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The dealing cycle’s id.
`payload`	The dealing cycle as it settled.
`payload.dealingCycleId`	The dealing cycle’s id.
`payload.instrumentId`	The fund’s id on the Registry.
`payload.strike`	The one NAV every order dealt at.
`payload.paidIn`	Every subscription’s payment into the fund’s payment account.
`payload.paidOut`	Every redemption’s payout from it.
`payload.net`	What the fund’s payment account moved; below zero, a net payout its treasury funded.
`payload.subscriptions`	How many subscriptions it settled.
`payload.redemptions`	How many redemptions it settled.
`payload.updateId`	The ledger update of the transaction it announces; null where the projection holds none for it.

`dealing-cycle.released`

Announces that the venue released a dealing cycle, so nothing allocated to it settles.

Field	What it carries
`type`	The event’s type.
`at`	The ledger time of the transaction it announces.
`seq`	The event’s position in the feed, `GET /v1/events`, from which a missed delivery is read back.
`offset`	The ledger offset of the transaction the event concerns; null where it concerns none.
`instrumentId`	The instrument the event concerns.
`resourceKind`	The kind of record it concerns.
`resourceId`	The dealing cycle’s id.
`payload`	The dealing cycle as it was released.
`payload.dealingCycleId`	The dealing cycle’s id.
`payload.instrumentId`	The fund’s id on the Registry.
`payload.updateId`	The ledger update of the transaction it announces; null where the projection holds none for it.

Journal events

The ledger’s facts are the feed’s journal events: GET /v1/events?kind=journal reads them, and no webhook is posted them. Each one’s payload:

`settlement.proposed`

The payload of settlement.proposed: a settlement intent created on the ledger.

Field	What it carries
`settlementId`	The settlement the intent proposes.
`collateral`	The id on the Registry of the instrument on the settlement’s other side: a reserve’s asset, or a dealing cycle’s deposit.
`price`	The price the settlement was composed at, a decimal in plain notation.

`price.point`

The payload of price.point: an oracle point created on the ledger.

Field	What it carries
`nav`	The NAV per unit, a decimal in plain notation.
`asOf`	The point’s instant.
`publisher`	The party that published the point.

`subscription.created`

The payload of subscription.created: a lot created on the ledger, the subscription priced.

Field	What it carries
`subscriptionId`	The subscription the lot is; the lot’s contract for one made under no id.
`units`	The units of the lot, a decimal in plain notation.
`apId`	The authorised participant that claimed it.
`appliedNav`	The NAV its attestors fixed, a decimal in plain notation.
`claimedAt`	When it was claimed.

`admission.offered`

The payload of admission.offered: an admission offer created on the ledger.

Field	What it carries
`holder`	The party offered the admission.
`holderId`	The registered holder the party is; null where none is.
`replaces`	The credential a re-issue replaces; null for a first admission.

`admission.granted`

The payload of admission.granted: a credential that admits a holder, created on the ledger.

Field	What it carries
`holder`	The party the credential’s claims admit.
`holderId`	The registered holder the party is; null where none is.
`instruments`	The instruments the credential admits the holder to, by their ids on the Registry.
`issuer`	The party that issued the credential: the venue, or the register keeper under its consent.

Related: Events and webhooks · Conventions

​Verify a delivery

​Events

​reconciliation.run

​reconciliation.finding

​reconciliation.hold

​hold.released

​statement.received

​statement.overdue

​distribution.payable

​distribution.held

​distribution.paid

​holder.restricted

​holder.unrestricted

​holder.forced-transfer

​holder.recovered

​instrument.paused

​distribution.rate-changed

​distribution.carried

​distribution.due

​standing-approval.granted

​standing-approval.revoked

​reserve.minted

​reserve.redeemed

​reserve.cover-low

​reserve.reported

​reserve.amended

​retention.pruned

​operation.succeeded

​operation.failed

​approval.requested

​approval.signed

​approval.approved

​approval.rejected

​subscription.priced

​subscription.delivered

​subscription.ended

​redemption.priced

​redemption.funded

​redemption.burned

​redemption.settled

​redemption.withdrawn

​dealing-cycle.settled

​dealing-cycle.released

​Journal events

​settlement.proposed

​price.point

​subscription.created

​admission.offered

​admission.granted