Zendesk

Integration Steps:

Step 1: Create a conversation field

Create a conversation field by going to Zendesk admin center. Go to Objects and rules then go to fields.

Click on Add Field and select the type as Text.

Set the permissions to Customers can edit .

Save the field and copy its field id, this will be needed in later steps.

Step 2: Install Zendesk chat widget

Go to channels in Zendesk admin center. Go to Channels section. Then go to messaging under messaging and social section. Create a channel if not created. Scroll to the Installation section and copy the code. Just paste this code snippet in before the closing </body> tag.

Step 3: Code to get Zipy session Url in Zendesk conversation

<script>
  setTimeout(() => {
    const zipySessionUrl = window.zipy.getCurrentSessionURL();
    zE("messenger:set", "conversationFields", [
        { id: <FIELD_ID>, value: zipySessionUrl }
    ]);
  }, 1500);
</script>

Note : Replace <FIELD_ID> by yours.

Note : setTimeout is used here to get zipy sesison url after zipy is initialized.

Refer this documentation for more info on Zendesk messenger events : https://developer.zendesk.com/api-reference/widget-messaging/web/core/#set-conversation-fields

Step 4: Zipy Session URL in Zendesk

After the above steps are completed whenever a user visits your application and starts conversation you can see the users' Zipy session url in Zendesk.

When viewing a specific conversation in Zendesk, navigate to the left panel. Here, you should find the field which you have created in previous steps to store Zipy session url along with its corresponding value, which represents the Zipy session URL.

Important Note: If you are using Web Widget (Classic) from Zendesk, as it does not allows you to update conversation field, you can send Zipy session url in pages viewed section using the script given below.

<script type="text/javascript">
  // Note : Insert this script after the Zendesk Installation script
  // This script will add the Zipy session URL to the Zendesk conversation's "pages viewed" section
  setTimeout(() => {
    const zipySessionUrl = window.zipy.getCurrentSessionURL();
    
    zE('webWidget', 'updatePath', {
      url: zipySessionUrl,
      title: "Zipy session"
    });
  },1500);
</script>