Integration Set-Up

The illu API is described in our Help Desk’s API Overview. In order to authenticate calls to the illu API, the sender will need the illu Organization ID and API Key. These can be found in the Admin Console of the illu web app. Given the sender will need to store this information, the user should confirm that the platform is storing the API Key securely (we recommend SHA-256 hashing) in order to avoid security issues.

Flow #1: Sync sites / customers

Main specification

• Platforms: Between illu and CRM (Upya or In-house)
• Summary: When new customers are connected and entered into the CRM platform, they are created in the illu platform as well to make it easy to link future tickets and requests

Data flow

• Upon the creation of new customer in CRM, the CRM platform calls or triggers the illu CREATE SITE endpoint POST api.illu.works/orgs/{org_id}/sites with the following data in the body.

{
"name": "string",
"latitude": 0,
"longitude": 0,
"address": "string"
}

• The CRM verifies a 201 response and receives the following data. The platform stores the site_id for future integration use

{
"site_id": 0,
"name": "string",
"is_active": true,
"org_id": 0,
"latitude": 0,
"longitude": 0,
"address": "string"
}

Flow #2: New O&M requests in CRM are passed into illu as new jobs

Main specification

• Platforms: Between illu and CRM (Upya or In-house)
• Summary: When new requests are received in the CRM platform, they created new jobs in the illu platform, passing on the relevant site information and details

Data flow

• Upon the receipt of a new request or ticket in the CRM, the CRM platform calls or triggers the illu CREATE JOB endpoint POST api.illu.works/orgs/{org_id}/jobs with the following suggested data in the body.
  • The sender will be able to define the job name and notes, and utilize the saved site_id (customer identifier) in order to initialize the job to the relevant requester.
  • If not provided, the assigned_user_id will be set to the admin whose API Key is being utilized
  • For more sophisticated users, specific tags and workflow instances can be defined using their ids in a custom script to create jobs with additional identifiers and information. These are not required

{
"name": "string",
"site_id": 0,
"due_date": "string",
"assigned_user_id": 0,
"notes": "string",
"tag_ids": [0],
"workflow_instances": [{}]
}

• The CRM verifies a 201 response and receives the following data. The platform stores the job_id for future integration use