data structure:
| Field | Type | Description |
|---|---|---|
affected_user | object | The employee being onboarded |
manager | object | The employee’s manager |
created_by | object | The actor who initiated the onboarding |
created_at | string | ISO 8601 timestamp of when the onboarding was created |
scheduled_for | string | ISO 8601 timestamp of the planned provisioning date |
- onboarding.scheduled
- onboarding.applications_selected
- onboarding.finished
Fired when a new onboarding is scheduled—either manually or via an HRIS integration.
{
"affected_user": {
"id": "8b15e986-84ac-4dbc-8e66-c82ebf3d2fc2",
"departments": [
"Engineering"
],
"email": "john.doe@example.com",
"full_name": "John Doe",
"job_title": "Software Engineer",
"location": "Berlin",
"manager": {
"id": "435c2e4c-2b3d-4c96-84ee-5667d671e1c1",
"email": "jane.manager@example.com",
"full_name": "Jane Manager"
},
"starting_at": "2022-07-16T23:42:00Z",
"teams": [
"Backend"
]
},
"created_at": "2022-07-13T23:42:00Z",
"created_by": {
"id": "5a3e57df-2d08-46be-b5bd-b3ea505a3d26",
"email": "admin@example.com",
"full_name": "Admin User",
"type": "manual"
},
"scheduled_for": "2022-07-16T23:42:00Z"
}
Fired when applications have been selected and assigned to the new employee’s onboarding. This event is emitted after an admin or automated policy determines which applications the new hire should receive access to.The
Each application carries a
data object includes one additional field:| Field | Type | Description |
|---|---|---|
assigned_applications | array | List of applications assigned to the onboarding, each with their resources and permissions |
resources array, and each resource a permissions array.{
"affected_user": {
"id": "8b15e986-84ac-4dbc-8e66-c82ebf3d2fc2",
"departments": [
"Engineering"
],
"email": "john.doe@example.com",
"full_name": "John Doe",
"job_title": "Software Engineer",
"location": "Berlin",
"manager": {
"id": "435c2e4c-2b3d-4c96-84ee-5667d671e1c1",
"email": "jane.manager@example.com",
"full_name": "Jane Manager"
},
"starting_at": "2022-07-16T23:42:00Z",
"teams": [
"Backend"
]
},
"assigned_applications": [
{
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"resources": [
{
"id": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
"permissions": [
{
"id": "11111111-2222-3333-4444-555555555555",
"title": "Editor"
},
{
"id": "66666666-7777-8888-9999-aaaaaaaaaaaa",
"title": "Viewer"
}
],
"title": "Engineering Team Drive"
}
],
"title": "Google Workspace"
},
{
"id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"resources": [
{
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"permissions": [],
"title": "#engineering"
}
],
"title": "Slack"
}
],
"created_at": "2022-07-13T23:42:00Z",
"created_by": {
"id": "5a3e57df-2d08-46be-b5bd-b3ea505a3d26",
"email": "admin@example.com",
"full_name": "Admin User",
"type": "manual"
},
"scheduled_for": "2022-07-16T23:42:00Z"
}
Fired when all provisioning steps for an onboarding have been completed.The
data object includes one additional field:| Field | Type | Description |
|---|---|---|
finished_at | string | ISO 8601 timestamp of when the onboarding completed |
{
"affected_user": {
"id": "8b15e986-84ac-4dbc-8e66-c82ebf3d2fc2",
"departments": [
"Engineering"
],
"email": "john.doe@example.com",
"full_name": "John Doe",
"job_title": "Software Engineer",
"location": "Berlin",
"manager": {
"id": "435c2e4c-2b3d-4c96-84ee-5667d671e1c1",
"email": "jane.manager@example.com",
"full_name": "Jane Manager"
},
"starting_at": "2022-07-12T23:42:00Z",
"teams": [
"Backend"
]
},
"created_at": "2022-07-09T23:42:00Z",
"created_by": {
"id": "5a3e57df-2d08-46be-b5bd-b3ea505a3d26",
"email": "admin@example.com",
"full_name": "Admin User",
"type": "manual"
},
"finished_at": "2022-07-13T23:42:00Z",
"scheduled_for": "2022-07-12T23:42:00Z"
}