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.

{
    "compliance_company_id": 1,
    "user_company_id": 1,
    "user_email": "[email protected]",
    "external_user_id": null,
    "status": "WAITINGAPPROVAL",
    "compliance_status_items": [
        {
            "usercompliancetype": "insurance",
            "status": "INCOMPLETE",
            "expiry_date": "2024-08-24T00:00:00.000000Z",
            "licence_name": "'Certificate of Insurance",
            "policy_amount": 2000000,
            "service_name": null,
            "service_code": null
        },
        {
            "usercompliancetype": "business_license",
            "status": "WAITINGAPPROVAL",
            "expiry_date": null,
            "licence_name": "Business Licence or Registration",
            "policy_amount": null,
            "service_name": null,
            "service_code": null
        },
        {
            "usercompliancetype": "trade_license",
            "status": "COMPLIANT",
            "expiry_date": null,
            "licence_name": "Cabinetmaker - (ON)",
            "policy_amount": null,
            "service_name": "Cabinetmaker",
            "service_code": "24Cabin"
        },
        {
            "usercompliancetype": "trade_license",
            "status": "COMPLIANT",
            "expiry_date": null,
            "licence_name": "Additional License",
            "policy_amount": null,
            "service_name": null,
            "service_code": null
        },
        {
            "usercompliancetype": "wsi",
            "status": "INPROGRESS",
            "expiry_date": null,
            "licence_name": "WSIB",
            "policy_amount": null,
            "service_name": null,
            "service_code": null
        }
    ]
}

List of all Compliance Status:

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

List of all Compliance Status Item Types:

Compliance Status Item Type	Description
criminal_check	Criminal record check search through police databases
credit_check	Personal credit check through Equifax
corporate_check	Corporate credit check through Equifax
insurance	Work insurance or COI
business_license	Business is officially licensed as an organization
trade_license	License to perform service such as trade license
wsi	Workplace Safety insurance
custom_documents	Corporate policies required for signature
drivers_license	License to operate a vehicle
certifications	Certifications required or supplementary to perform work
billing	User had paid for subscription
prequal_approved	Prequal has been approved if that workflow is active
qr_badge	Verified identification badge for on premise work