User Subscription Events
Subscription key: user_subscription
Events delivered to your user_subscription URL are fired when a user account is activated, deactivated, or updated on the platform.
user.* - User Events
| Event | When it fires |
|---|---|
user.created |
A user account is created on the platform |
user.activated |
A user account is activated on the platform |
user.deactivated |
A user account is deactivated |
user.updated |
A user’s profile details are updated |
| Field | Type | Nullable | Description |
|---|---|---|---|
eventType |
string | No | user.activated, user.deactivated, user.updated or user.created |
tenantId |
string | No | Your Thrive tenant identifier |
user |
object | Yes | The affected user. May be null in rare cases if user data was unavailable at dispatch time |
user.id |
string | No | User ID |
user.reference |
string | Yes | External reference (e.g. HR system ID). May be null if not set |
user.firstName |
string | Yes | First name |
user.lastName |
string | Yes | Last name |
user.email |
string | Yes | Email address |
user.status |
string | Yes | Account status |
user.role |
string | Yes | Platform role |
createdAt |
string | No | ISO 8601 timestamp of when the event occurred on the platform |
dispatchedAt |
string | No | ISO 8601 timestamp of when this webhook was dispatched |
Example payload (user.activated):
{
"eventType": "user.activated",
"tenantId": "acme-corp",
"user": {
"id": "usr_abc123",
"reference": "EMP-00042",
"firstName": "Jane",
"lastName": "Smith",
"email": "jane.smith@acme.com",
"status": "active",
"role": "learner"
},
"createdAt": "2024-03-15T10:30:00.000Z",
"dispatchedAt": "2024-03-15T10:30:01.234Z"
}