payload of every item in the event list, is the same envelope. data is the full current state of the object the event is about, never a delta, so you can always apply the latest version you hold.
Event types
The names follow the
domain.resource.action convention of Securitize’s other webhook families; every type of this API is in the ca domain. New types can be added in minor versions: apply data by version for an eventType you do not know, and keep going.
The request body of each event, with an example, is in the API reference under Webhooks.
Delivery guarantees
- At least once. The same event can arrive more than once, with the same
sourceEventId. - Possibly out of order. Deliveries run in parallel; order by
stream.idandsequence. - Within 60 seconds of publication is the target; a scenario in sandbox arrives within seconds.
- Retried for 72 hours on anything but a
2xxwithin 10 seconds, then marked failed and kept 90 days for replay and recovery.
Publication timing
Securitize’s target isca.action.created within one business day of confirming an announcement, and the urgent events, cancellations, postponements and Securitize-originated restrictions, as soon as possible. Final commitments are in the commercial agreement.