Using Conversation Deep Links
You can integrate Zinc with third-party apps and web pages by using Conversation Deep Links, which are URLs that users can click in another app or website to create or join Zinc Conversations. Zinc Android, iOS, and desktop apps support these universal deep links, which automatically open in Zinc if Zinc Mobile is installed on the device or Zinc Desktop is installed on the system. Otherwise, users are directed to Zinc Web.
Conversation Deep Links
Conversation Deep Links ease the use of Zinc as a communication layer to complement other applications.
Supported Path
/cnv/:conversation_id: Opens or creates a Conversation
Query Parameters
|
Parameter
|
Description
|
|---|---|
|
participants
|
List of email address of members to be included in a Conversation.
|
|
title
|
Conversation title. Optional. If left blank, the Conversation is created without a title.
|
|
body
|
Text of a Message to be sent. Optional. If left blank, the Message has a blank body.
|
|
external_id
|
The identifier for an object outside of Zinc. Optional. If specified, the link either creates a new Conversation linked to the external object, or directs users to an existing Conversation if available.
|
Examples
• Specifying conversation participants:
https://zinc-app.com/cnv?participants=bob%40zinc.it%2Csue%40zinc.it
• Specifying a conversation title:
https://zinc-app.com/cnv?title=My%20Conversation%20Title
• Specifying a message body:
https://zinc-app.com/cnv?body=This%20is%20a%20message%20body
• Specifying an external object ID:
https://zinc-app.com/cnv?external_id=sfdc-account-abc12345d6e7
Formatting External IDs
You can use external IDs to link a Zinc Conversation to an object in an external system. Currently, we support external IDs for objects in Salesforce and ServiceMax.
External ID Format
external_id=<external system>-<object type>-<object ID>
Supported External Systems
• smax: ServiceMax
• sfdc: Salesforce
Supported Object Types
All Salesforce and ServiceMax object types are supported, including custom object types. The following object types are supported out-of-the-box. Support for other object types requires additional configuration.
|
Object Type
|
System
|
|---|---|
|
account
|
Salesforce, ServiceMax
|
|
case
|
Salesforce
|
|
contact
|
Salesforce, ServiceMax
|
|
installedproduct
|
ServiceMax
|
|
lead
|
Salesforce
|
|
opportunity
|
Salesforce
|
|
workorder
|
ServiceMax
|
|
location
|
Salesforce, ServiceMax
|
Example: External ID for a Lead in Salesforce
external_id=sfdc-lead-<salesforce_id>
 |
To use external IDs, you must have an account with the relevant external system, and Zinc must be configured to connect to that account. For more information, see About ServiceMax Integration.
“
|
Sample URLs
Participants, Title and Body
https://zinc-app.com/cnv?participants=bob%40zinc.it%2Csue%40zinc.it&title=New%20Workorder&body=There%20is%20a%20new%20workorder%20to%20assign
When users click this link, Zinc opens to the Message Composer prepopulated with a title (New Workorder), a Message body (There is a new workorder to assign), and two Message recipients (bob@zinc,it and [email protected]).
Title, Body and External ID
https://zinc-app.com/cnv?title=Acme%20Inc&body=This%20is%20a%20discussion%20about%20the%20Acme%20account&external_id=sfdc-account-0011M0000294qyi
When users click this link, the Zinc native or the browser app opens to the Message Composer prepopulated with a title (Acme Inc) and a Message body (This is a discussion about the Acme account). The conversation is also linked to a Salesforce account whose Salesforce ID is 0011M0000294qyi.
When users click this URL a second time, they are directed to the same Zinc Conversation. The external_id parameter creates this persistent connection.
For more information: