Event Message Data Objects

Event: Activity or action taken by a banking application user or by the system that can be recorded. Events include logging in, changing email addresses, updating an account nickname, creating a new transfer, etc.

Event Message: The data that describes the event that has occurred. The data is not available in real time but is an historic record of the event. Event messages are stored and may also be sent to registered partner systems as webhooks. Each event message contains data which describes the event. The event  contain both specific information about the event itself and common metadata about the event, such as when the event occurred, the category and type of the event, and who performed the action.

Each event message is represented as a JSON object defined by the eventMessageItem schema. The top level fields in an eventMessageItem are metadata which describes the event:

• who or what did something (agentId, agentType, coreCustomerId, customerSerialId)
• what action they performed (type, category),
• when they did it (occurredAt),
• where they did it (host),
• what they did it to (primaryId, secondaryId)
• sessionId if the event occurred within a logged-in user session,
• additional data that is specific to the activity type.

Each event is described by a category and a type. Related event types are organized into categories, such as authentication for events related to logging in, or transfers for activities related to account-to-account transfers, or profile for activities related to managing a customer’s profile (addresses, phone numbers, etc.),
or accountApplications for events related to
applying to open a new banking account.

See the Event Types by Category section of the Events Administration API documentation to see a list of event types sorted by by category. For example, when a banking customer creates a new account-to-account transfer, the system
records a new event with the category transfers and the type singleTransferCreated.

The primaryId and secondaryId properties of an event message item convey the API resource ID of the primary and secondary banking resource that the event pertains to. For example, when a banking customer cancels a wire transfer (type is wireTransferCreated), the primaryId is the ID of the wire transfer resource. The Data Direct:Real-Time service API client may use the Business Transfers Administration API to fetch the details of the wire transfer payment batch if it need to view additional details of the wire transfer. Thus, event messages are kept relatively small rather than including all possible details of the related resources, as that data is not unique to each event.

Within each event message item is a data object
which contains the data that is specific to that event type. The content of this data object varies for each event type.
For example, for the event message type singleTransferCreated, the data object contains the properties defined by the
singleTransferCreatedEventSchema schema. Each data schema is named by appending the suffix EventSchema to the event type. These data schema are listed for each event type in the Event Types by Category table.

User Session Duration: A user session begins when the user logs in. A user session ends when they log out, close their browser, or after a pre-determined amount of time.

sessionId and userLoggedIn: The sessionId in the event message is a unique identifier for a user’s session. When a user logs in, the system creates a new session and an event with category authentication and type userLoggedIn records the action and sessionId. The userLoggedInEventSchema data contains the userLoggedIn event message created at the start of the user’s session includes the user’s browser and operating system in the data object. The sessionId is present in all events that are triggered during the user’s session. After one session ends and a new session begins, event messages created during the new session have a new sessionId.