Skip to main content
AccessOwl emits webhook events throughout the onboarding lifecycle. All onboarding event payloads share a common data structure:
FieldTypeDescription
affected_userobjectThe employee being onboarded
managerobjectThe employee’s manager
created_byobjectThe actor who initiated the onboarding
created_atstringISO 8601 timestamp of when the onboarding was created
scheduled_forstringISO 8601 timestamp of the planned provisioning date

​
onboarding.created

Fired when a new onboarding is created—either manually or via an HRIS integration. 
{
  "affected_user": {
    "departments": [
      "Engineering"
    ],
    "email": "john.doe@example.com",
    "full_name": "John Doe",
    "id": "8b15e986-84ac-4dbc-8e66-c82ebf3d2fc2",
    "job_title": "Software Engineer",
    "location": "Berlin",
    "starting_at": "2022-07-16T23:42:00Z",
    "teams": [
      "Backend"
    ]
  },
  "created_at": "2022-07-13T23:42:00Z",
  "created_by": {
    "email": "admin@example.com",
    "full_name": "Admin User",
    "id": "5a3e57df-2d08-46be-b5bd-b3ea505a3d26",
    "type": "manual"
  },
  "manager": {
    "email": "jane.manager@example.com",
    "full_name": "Jane Manager",
    "id": "435c2e4c-2b3d-4c96-84ee-5667d671e1c1"
  },
  "scheduled_for": "2022-07-16T23:42:00Z"
}

​
onboarding.rescheduled

Fired when the provisioning date of an existing onboarding is changed. The scheduled_for field in data reflects the new date. 
{
  "affected_user": {
    "departments": [
      "Engineering"
    ],
    "email": "john.doe@example.com",
    "full_name": "John Doe",
    "id": "8b15e986-84ac-4dbc-8e66-c82ebf3d2fc2",
    "job_title": "Software Engineer",
    "location": "Berlin",
    "starting_at": "2022-07-16T23:42:00Z",
    "teams": [
      "Backend"
    ]
  },
  "created_at": "2022-07-13T23:42:00Z",
  "created_by": {
    "email": "admin@example.com",
    "full_name": "Admin User",
    "id": "5a3e57df-2d08-46be-b5bd-b3ea505a3d26",
    "type": "manual"
  },
  "manager": {
    "email": "jane.manager@example.com",
    "full_name": "Jane Manager",
    "id": "435c2e4c-2b3d-4c96-84ee-5667d671e1c1"
  },
  "scheduled_for": "2022-07-16T23:42:00Z"
}

​
onboarding.finished

Fired when all provisioning steps for an onboarding have been completed. The data object includes one additional field:
FieldTypeDescription
finished_atstringISO 8601 timestamp of when the onboarding completed
{
  "affected_user": {
    "departments": [
      "Engineering"
    ],
    "email": "john.doe@example.com",
    "full_name": "John Doe",
    "id": "8b15e986-84ac-4dbc-8e66-c82ebf3d2fc2",
    "job_title": "Software Engineer",
    "location": "Berlin",
    "starting_at": "2022-07-13T23:42:00Z",
    "teams": [
      "Backend"
    ]
  },
  "created_at": "2022-07-10T23:42:00Z",
  "created_by": {
    "email": "admin@example.com",
    "full_name": "Admin User",
    "id": "5a3e57df-2d08-46be-b5bd-b3ea505a3d26",
    "type": "manual"
  },
  "finished_at": "2022-07-13T23:42:00Z",
  "manager": {
    "email": "jane.manager@example.com",
    "full_name": "Jane Manager",
    "id": "435c2e4c-2b3d-4c96-84ee-5667d671e1c1"
  },
  "scheduled_for": "2022-07-13T23:42:00Z"
}