Introduction
This document provides a high-level overview of several pre-built nodes that are available in Webex Connect to enable appointment management, contacts management, reports generation in IMIASSIST. The nodes need to be enabled for the Webex Connect tenant by admin, to be available for use within the respective tenant.
IMIASSIST offering is now end of sale. This integration is available only for eClinic customers, to configure integrations with eClinic.
Node Outcomes
In Webex Connect, nodes have one or more outcome edges (which can be used to configure transitions to the next logical node based on the requirements) that correspond to various success or error cases. The following are some of the typical node outcomes:
- Success – Request processing successful
- Failure- Request processing failed
- onTimeout – Request processing timed out
- on Error – Request processing failed due to an error
- onInvalidData – Request processing failed due to missing data
- onInvalidChoice – Request processing failed but there is no outcome configured for the concerned scenario
IMIASSIST Pre-Built Nodes Summary
The following pre-built nodes are available in IMIASSIST.
| Node Names | Description | Methods |
|---|---|---|
| Authentication | Gets an API key and token, which can further be used to invoke IMIASSIST APIs. | Authenticate Get New Token Get Existing Token |
| Create Appointment | Schedules an assigned / unassigned appointment in IMIASSIST. | Schedule an Appointment |
| Cancel Appointment | Cancels an existing appointment in IMIASSIST. | Cancel by Appointment ID Cancel by Appointment UID Cancel by Appointment Data |
| Add Participant | Add new participant(s) to an existing appointment in IMIASSIST | Add Host by Appointment ID Add Host by External Reference ID Add Guest by Appointment ID Add Guest by External Reference ID |
| Remove Participant | Remove a participant from an existing appointment in IMIASSIST | Remove by Appointment ID and Participant ID Remove by Appointment ID and Client ID Remove by Appointment ID and Phone Remove by Appointment ID and email Remove by Appointment ID, Phone and email Remove by External Reference ID and Participant ID Remove by External Reference ID and Client ID Remove by External Reference ID and Phone Remove by External Reference ID and email Remove by External Reference ID, Phone and email |
| Appointment Report | Generates a consolidated report of completed appointments in IMIASSIST | Create an Appointment Report |
| Usage Report | Generates a usage report of billable transactions in IMIASSIST | Create a Usage Report |
| Transactions | Gets the status and information about an API transaction in IMIASSIST. | Get a Transaction |
| Contacts Management | Create, update, delete customer contact records in IMIASSIST. | Create a Contact Update a Contact by Contact ID Update a Contact by Customer ID Update a Contact by Phone Update a Contact by Email Update a Contact by Email and Phone Delete a Contact by Customer ID Delete a Contact by Client ID Delete a Contact by Phone Delete a Contact by Email Delete a Contact by Email and Phone |
Updated 11 months ago