On Flow Started
Triggered when your customer opens the Financial Rider experience and the session goes live.
data is the browser context it was opened with — origin, user agent, address —: the first line of the session’s audit trail. Nothing has been connected yet.
What data carries, and what actually travels
The schema below describes data decrypted — on purpose, so this reference has a model you can read and code against. What arrives at your endpoint depends on how the session was created:
- With an
aes_key:datais a single string,aes::Base64(IV + Ciphertext + Tag). Decrypt it and you get exactly the object documented below. The walkthrough and the code are in Payload Encryption. - Without an
aes_key:datais not in the body at all — absent, notnull. The event still tells you what happened.
Events are delivered at least once: deduplicate by session_id and event.
Answer 2xx as soon as the payload reaches you, whatever your processing does with it afterwards: any other status is recorded as a failed delivery even though the event arrived. Answering a delivery has the handler to copy.
Payload
Payload class discriminator — always this value for Financial Rider events.
The event type: started.
The browser context the session was opened with. Documented decrypted: on the wire it is the
aes::… string of this object when the session carries an aes_key, and absent when it does
not.