Franchise onboarding

Event wrapper values

• When an onboarding process has been completed

Field	Value(s)
eventType	onBoardingCompleted
operation	create

Data Schema

{
  "onBoardingCompleted": {
    "tenantKey": "UUID",
    "contact": {
      "firstname": "STRING",
      "lastname": "STRING",
      "email": "STRING"
    },
    "dateSigned": "UTC_TIMESTAMP",
    "pricingGridUrl": "STRING",
    "pricingGridVersion": "NUMBER",
    "termsOfServiceUrl": "STRING",
    "termsOfServiceVersion": "NUMBER"
  }
}

Description

Field	Type	Description
tenantKey	UUID	This is Empego’s tenant’s unique identifier.
contact	Contact object	This JSON Object refers to the contact person’s informations that completed the onboarding.
dateSigned	UTC_TIMESTAMP	Timestamp for when the onboarding was completed. The format is yyyy-MM-dd HH:mm:ss.SSS .
pricingGridUrl	STRING	The URL of the pricing grid PDF.
pricingGridVersion	NUMBER	This numeric value represents the version of the pricing grid agreement that the user has agreed to.
termsOfServiceUrl	STRING	The URL of the pricing grid PDF.
termsOfServiceVersion	NUMBER	This numeric value represents the version of the terms of service agreement that the user has agreed to.

Example

{
  "onBoardingCompleted": {
    "tenantKey": "11f81012-9519-XXXX-0244cd4cfa84",
    "contact": {
      "firstname": "John",
      "lastname": "Doe",
      "email": "johndoe@example.ca"
    },
    "dateSigned": "2024-03-13 23:37:54.000",
    "pricingGridUrl": "https://integration.empego.ca/latestPricingGri3412223.pdf",
    "pricingGridVersion": 1,
    "termsOfServiceUrl": "https://integration.empego.ca/latesttermsOfService3123412223.pdf",
    "termsOfServiceVersion": 2
  }
}

Contact Object:

Field	Type	Description
firstname	STRING	The contact person’s first name.
lastname	STRING	The contact person’s last name.
email	STRING	The contact person’s email.