Imports a list of events
How it Works
The /v1/events/import endpoint allows you to send various types of events that can influence a customer's record and behavior on the spektr platform. This endpoint allows you to integrating your external data, which enrich spektr's ability to, for example, monitor transactions and acknowledge external changes.
Supported Event Types
Currently, spektr currently supports two event types that can be sent via this endpoint:
recordUpdated: This event type is used to signify a change or update to a customer's record or profile within your system. Examples include changes to contact information, identity documents, or other relevant customer attributes.
paymentMade: This event type is used to report a payment transaction initiated or received by a customer. This is crucial for monitoring financial transactions and identifying unusual payment patterns.
Event Schema Requirements
Each supported event type (recordUpdated and paymentMade) has a predefined schema that must be strictly adhered to when sending data to the endpoint. Adhering to these schemas ensures that spektr can correctly parse, process, and link your event data to the relevant customer profiles.
To ensure you are sending correctly formatted events, please refer to the dedicated schema documentation for each event type:
recordUpdated Event Schema: to be added
paymentMade Event Schema: paymentMade schema documentation
Event Orchestration and Customer Linking
For your sent events to be properly considered and linked to a specific customer within spektr, an event orchestration process must be created and configured on the spektr platform. This configuration defines how your incoming events are mapped to customer identities and how they trigger specific monitoring rules or risk assessments.
Customer Identifier Mapping: Ensure that the customer identifiers within your recordUpdated and paymentMade events can be accurately mapped to existing customer profiles in spektr.
Rule Configuration: Configure your event orchestration to trigger the appropriate transaction monitoring rules and alerts based on the incoming event data.