Administrator
Administrator
0 0 8
2 weeks ago

Summary

Learn how you can link to the Zinc app from external systems.

Product Line

Zinc

Version Validated In

N/A

Overview

Learn how you can link to the Zinc app from external systems.

Step-by-Step

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.


Supported Paths

/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.

Query Parameters
  • 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
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

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
  • account (Salesforce, ServiceMax)
  • case (Salesforce)
  • contact (Salesforce, ServiceMax)
  • installedproduct (ServiceMax)
  • lead (Salesforce)
  • opportunity (Salesforce)
  • workorder (ServiceMax)
An external ID for a lead in Salesforce, for example, would look like this:

external_id=sfdc-lead-<salesforce_id>

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.


Sample URLs

Participants, Title and Body
https://zinc-app.com/cnv?participants=bob%40zinc.it%2Csue%40zinc.it&title=New%20Workorder&body=There...

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 (bob@zinc.it and sue@zinc.it).

Title, Body and External ID
https://zinc-app.com/cnv?title=Acme%20Inc&body=This%20is%20a%20discussion%20about%20the%20Acme%20acc...

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.


Limitations

Currently, all deep link parameters are fully supported for iOS and desktop platforms. Android support is currently incomplete, but is planned for the future. This article will be updated when Android support is complete.
 

Terms of Use

ServiceMax terms of use are as follows: Images and content used on this site are owned or licensed by ServiceMax Inc. or its affiliates for use on this site only. Unauthorized use is prohibited.

©2015 ServiceMax. All Rights Reserved.

Note: ServiceMax makes every effort to ensure the accuracy of the information contained within this article, but assumes no responsibility or liability for any errors or inaccuracies that may appear. All references to versions, system requirements or supported features should be referenced within online help documentation for most up to date information. If you do find any errors or inaccuracies, please send your feedback to knowledge@servicemax.com.