Webhook Events

This is a list of all the types of events we currently send.

Event	Description
user.created	Occurs whenever a user in system is created.
user.updated	Occurs whenever a user's profile in system is updated.
user.deactivated	Occurs whenever a user's account is deactivated.
user.compliance_status.updated	Occurs whenever a user's overall compliance status is updated.

Events Payload

`user.created`

Below is an example of the data that will be sent

{
  "event_type": "user.created",
  "data": {
    "fname": "User First Name",
    "lname": "User Last Name",
    "email": "[email protected]",
    "phone": null,
    "company_id": 1,
    "company_name": "Company Name",
    "status": "active", // "deactivated"
    "profile_code": "C",
    "city": null,
    "address": null,
    "country_id": null,
    "province_id": null,
    "postal_code": null,
    "notification_email": null,
    "created_on": "2024-08-09T10:13:36.000000Z",
    "updated_on": "2024-08-09T10:13:36.000000Z"
  }

`user.updated`

Below is an example of the data that will be sent.

{
  "event_type": "user.updated",
  "data": {
    "fname": "User First Name",
    "lname": "User Last Name",
    "email": "[email protected]",
    "phone": null,
    "company_id": 1,
    "company_name": "Company Name",
    "status": "active", // "deactivated"
    "profile_code": "C",
    "city": null,
    "address": null,
    "country_id": null,
    "province_id": null,
    "postal_code": null,
    "notification_email": null,
    "created_on": "2024-08-09T10:13:36.000000Z",
    "updated_on": "2024-08-09T10:13:36.000000Z"
  }

`user.deactivated`

Below is an example of the data that will be sent.

{
  "event_type": "user.deactivated",
  "data": {
    "name": "User Full Name",
    "email": "[email protected]",
    "company_id": 1,
    "company_name": "Company Name",
    "status": "active", // "deactivated"
    "profile_id": 1,
    "profile_code": "C"
  }

`user.compliance_status.updated`

Below is an example of the data that will be sent.

{
  "event_type": "user.compliance_status.updated",
  "data": {
    "compliance_company_id": "<ID of Company Compliance ID>",
    "user_company_id": "<ID of User Company ID>",
    "user_email": "[email protected]",
    "status": "COMPLIANT",
  }

List of all Compliance Status:

Compliance Status	Description
COMPLIANT
EXPIRED
NONCOMPLIANT
INPROGRESS
EXPIRING
NEEDSREVIEW
WAITINGAPPROVAL
NOTSTARTED
SUBMITTED
INCOMPLETE
IDUNVERIFIED
SUSPENDED
TERMINATED
CANCELED
TRIAL
REJECTED