Deep Linking Integration

 

Qwil Messenger enables users to interact with our app user interface to integrate and automate the use of the channel via URL deep links.

Essentially, a user can navigate to a specific part or function of the app via a properly constructed URL. Currently, we support the following deep link URL actions:

• Start a new chat
• Navigate to an existing chat, or message within a specific chat.
• Export a PDF transcript of a chat.
• Export chat attachments.
• Pre-fill a client or staff invitation
• Search in data reviewer

 

Security and Usage Considerations:

To use a deep link successfully, the following considerations apply.

• The browser session launched using the URL shortcut is responsible for managing the authentication and permission level access of the user to perform the actions associated with the URL deep link.
• If a user has remembered their credentials via a browser cookie, the user following a deep link will not have to enter any security credentials and the action of the URL link will be performed seamlessly when the link is followed from another application.
• If authentication is required, the link will still work after the details have been entered.
• If a user has authentication access to the app but not the permission levels required to follow the link, then an error in the application itself will be displayed to the user that attempts to follow the link.

 

How to start a new chat with deep links:

Specific parameters can be used to construct a deep link to start a new chat. New chats must have at least one participant. Optionally, they can have additional participants, a specific chat title and a first message to be automatically sent.

Here is a list of the parameters that can be used to construct a deep link to start a new chat:

 

To start a new chat, a URL needs to be constructed that complies with the following parameters and formatting conventions:

 

How to Export from a chat with deep links:

The two parameters required to export chat attachments and PDF transcript are:

• [ORGANISATION_UUID] - The unique UUID specific to the Qwil organisation within which the chat exists. Can be found in the URL once logged into the Qwil organisation on web.
•  [CHAT] - The unique UUID specific to the chat, can be found in the URL after "Chats/"

To export a chat PDF, a URL needs to be constructed that complies with the following parameters and formatting conventions:

https://web.qwil.io/web/organisations/[ORGANISATION_UUID]/0/chats/[CHAT]/pdf

And to export chat attachments:

https://web.qwil.io/web/organisations/[ORGANISATION_UUID]/0/chats/[CHAT]/zip

 

How to pre-fill an invitation using deep links:

Specific parameters can be used to construct a deep link to pre-fill an invitation. All fields are optional. When you follow a deep link to fill an invitation, fields will be prepopulated in the invitation modal for you to review them before sending out the invitation. 

Here is a list of the parameters that can be used to construct a deep link to pre-fill an invitation:

To pre-fill an invitation, a URL needs to be constructed that complies with the following parameters and formatting conventions. All values are optional:

https://web.qwil.io/web/organisations/[ORGANISATION_UUID]/0/profile/clients/create? [FIRSTNAME=value]&[LASTNAME=value]&[EMAIL=value]&[PHONENUMBER=value]&[IDENTIFIER=value]

 

How to use deep links with data reviewer:

Specific parameters can be used to construct a deep link to find conversations in data reviewer. You must have data reviewer permission to access the functionality via a deep link. According to your permission level, certain fields may be mandatory. 

• For level 1 & 2 you must provide at least one participant or one chat uuid.
• For level 3 all fields are optional.

When you follow a deep link with data reviewer search parameters, the data reviewer page will be loaded with your filtering fields populated.

To search in data reviewer, a URL needs to be constructed that complies with the following parameters and formatting conventions. 

https://web.qwil.io/web/organisations/[ORGANISATION_UUID]/0/audit/[PARTICIPANTS=%5Bvalue%5D]=true&[SENDERS=%5Bvalue%5D]=true