Skip to main content

User Session webhook payload

The resource:url for a User Session webhook payload uses this basic format:

https://marketplace_url/api/account/v1/users/user_id

Here marketplace_url is the main URL for the marketplace (for example, mycompany.byappdirect.com), and user_id is the marketplace identifier for the user (for example, 4ef60b96-6180-4d82-8080-6f59ff51e2d3).

When this webhook fires

  • User Session Added — When a user successfully logs in to the marketplace.
  • User Session Removed — When a user explicitly logs out of the marketplace.

Content payload

When a User Session:Added or User Session:Removed webhook is triggered, the content section of the payload includes the following attributes:

AttributeTypeDescription
userEmailAddressStringThe email address of the user whose session was created or ended.
userUuidStringThe universally unique identifier (uuid) of the user whose session was created or ended.
partnerStringThe identifier of the marketplace (tenant) where the session event occurred.
ipAddressStringThe IP address from which the user logged in. For a Removed event, this is the IP address from which the user logged out.
createdOnStringThe timestamp of the user's last successful login, in ISO 8601 format (for example, 2026-03-15T14:30:00Z). May be null if the login timestamp is unavailable.

Example payload

{
"uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"timestamp": 1742054400000,
"resource": {
"type": "USER_SESSION",
"uuid": "4ef60b96-6180-4d82-8080-6f59ff51e2d3",
"url": "https://mycompany.byappdirect.com/api/account/v1/users/4ef60b96-6180-4d82-8080-6f59ff51e2d3",
"content": {
"userEmailAddress": "johndoe@example.com",
"userUuid": "4ef60b96-6180-4d82-8080-6f59ff51e2d3",
"partner": "ACME",
"ipAddress": "192.168.1.100",
"createdOn": "2026-03-15T14:30:00Z"
}
},
"resourceAction": "ADDED"
}

Was this page helpful?