| Term | Meaning |
|---|---|
| Asset | One CET: one underlying share class, identified by assetId, deployed as one token per chain |
| CET | Convertible Entitlement Token: an entitlement to one underlying US-listed share, held at a clearing firm, convertible into the share |
| Corporate action | An event on the underlying share that affects holders: a dividend, split, merger, tender offer, meeting and so on. Identified by sourceCaId |
changedFields | The dot paths of an object that differ from its previous version |
| Deployment | One token of an asset on one chain: tokenId, chainId, contractAddress |
| Envelope | The body of every webhook and the payload of every event list item: what happened, to what, at which version, with the object’s full state in data |
| Event | One notification about a corporate action, a restriction or a token, identified by sourceEventId |
| Effective market status | marketStatus of a token: UNAVAILABLE while a restriction stops trading, otherwise the underlying market’s OPEN or CLOSED |
| Market dates | exDate, recordDate, payDate, announcementDate: calendar dates on the New York calendar, YYYY-MM-DD |
| Multiplier | The factor between a holder’s raw on-chain balance and the balance displayed. A split changes it at effectiveTime without moving raw balances |
| Option | One choice a holder can make in a corporate action with options or a voluntary one |
| Recover | Resending the webhook deliveries that failed in a time window, with their original ids |
| Replay | Reading the webhooks sent to you in the last 90 days through GET /events |
| Restriction | A trading halt, suspension, pause, wind-down or special restriction on a token, an asset or an underlying market, identified by restrictionId |
| Scope | What a restriction applies to: TOKEN, ASSET or UNDERLYING_MARKET |
sequence | The position of an event within its token stream; strictly increasing, with gaps |
| Settlement | On a completed corporate action: the distribution contracts, transaction hashes and aggregate totals for the asset |
| Snapshot time | The CET entitlement cut-off: 8:00 pm New York time on the business day before the ex-date or record date |
sourceEventId | The id of an event, in the body of its webhook; the deduplication key; the eventId of the event list. Not the svix-id header, which is the message id |
| Stream | The ordered sequence of events of one token |
| Supersede | A corporate action re-announced as a new one: the new carries supersedesCaId, the old is cancelled with supersededByCaId |
| Token | One deployment of an asset on one chain, identified by tokenId |
| Underlying | The listed share a CET is an entitlement to, with its ticker, isin, mic and lei as reference data |
| Venue actions | venueActions: what a venue needs to do about a corporate action, such as stop trading or set a pool mode |
| Version | Per object, from 1, one more on every change. What a consumer applies by |
Help
Glossary
The terms these docs use, in one place.