Login
An event sent on successful login
RabbitMQ Connector
Kafka Connector
REST API
RabbitMQ Message Properties
key | value |
type | LOGIN_V2 |
The type is expected as a property (but not in the payload) of the RabbitMQ Message. Any header will be ignored.
Kafka Message Headers
key | value |
type | LOGIN_V2 |
⬆️ POST /v2/integration/login
This message needs to be published whenever a user makes a login. Try to push it as close as possible to the login taking place in the platform for the best experience.
When we receive the message on the integration platform, it will fetch user details by calling the Operator API and then update user details.
Example Payload
Data Types
Required properties are marked with *
Key | Example Value | Description |
user_id * | "7865312321" | The unique id of the user |
is_impersonated | true | This field is true when a support agent is logged in impersonating a user |
ip_address | "192.0.2.1" | IP Address |
timestamp * | "2015-03-02T8:27:58.721607Z" | Timestamp of login in RFC3339 format |
origin * | "sub.example.com" | The Origin |