The Zinc Android, iOS, and desktop apps support universal deep links. Deep links will automatically open in Zinc if it's installed on the phone or desktop, otherwise, users will be directed to the Zinc web browser app.
/cnv/:conversation_id - Opens or creates a conversation
/g/:group_link_hash - Opens or joins an existing group
Conversation Deep Links
Conversation deep links allow users to create Zinc conversations from another app or website using a URL. This makes it easier to use Zinc as a communication layer to complement other applications.
- participants: List of email addresses of members to be included in the conversation.
- title: Title of the conversation. If this is omitted then the conversation won’t have a title.
- body: Text for the message to be sent. If this is omitted then the message field will be blank.
- external_id: The “external object” identifier for an object outside of Zinc. If this parameter is included then the link will either create a new conversation tied to the external object or will direct to the conversation if one already exists.
Specifying conversation participants
Specifying a conversation title
Specifying a message body
Specifying an external object ID
External IDs allow you to tie a Zinc conversation to an object that exists in an external system. Currently, we support external IDs for objects in Salesforce and ServiceMax, with support for further systems coming in the future.
Formatting external IDs
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, while other object types not on this list will require additional configuration to support:
- account (Salesforce, ServiceMax)
- case (Salesforce)
- contact (Salesforce, ServiceMax)
- installedproduct (ServiceMax)
- lead (Salesforce)
- opportunity (Salesforce)
- workorder (ServiceMax)
- location (Salesforce, ServiceMax)
An external ID for a lead in Salesforce, for example, would look like this:
Requirements for using external IDs
In order to use a deep link containing an external ID, a user must have an account with the relevant external system, and they must enable Zinc to connect to that account. Refer to this article to connect external accounts.
Participants, Title and Body
This link will open the Zinc native app (or the browser app if the native app is not installed) and will open the message composer. The composer will be prepopulated with a title (“New Workorder”), a message body (“There is a new workorder to assign”), and two message recipients (firstname.lastname@example.org and email@example.com).
Title, Body and External ID
This link will open the Zinc native app (or the browser app if the native app is not installed) and will open the message composer. The composer will be prepopulated with a title (“Acme Inc”) and a message body (“This is a discussion about the Acme account”). The conversation will also be tied to a Salesforce account with a Salesforce ID of 0011M0000294qyi.
If a user goes to this URL a second time, they will be directed to the same Zinc conversation. The reference to an external_id parameter creates this persistent connection.