In this article, we'll walk you through each stage of the integration process between Zendesk and Claudia.
1. Setting up the Helpdesk
-
Go to the Integration screen in the panel.
-
On the toggle, choose whether it will be an email or a chat integration.
-
In the "Subdomínio" (Subdomain) field, add the subdomain of the Zendesk account.
-
Log in to Zendesk and copy the subdomain from the URL, for example, https://subdomain.zendesk.com.
Example filled in incorrectly ❌:
Example filled in correctly ✅:
.png)
-
-
In the "Usuário" (User) field, enter the login email you use to sign in to Zendesk.
-
In the "Token" field, paste the Zendesk API token.
- In Zendesk, go to Admin Center > Apps and integrations > APIs > Zendesk API.
-
In "ID do Grupo da Claudia" (Claudia's Group ID), you can add the ID if one already exists; if it doesn't, just leave it blank and we'll create a group in Zendesk.
-
And in the "Grupo N2" (N2 Group) field, we enter the ID of the group Claudia should send tickets to when handing over to a human.
-
In Zendesk, go to Admin Center > People > Groups.
-
Click the name of the group you want to use and, in the page URL, copy the numeric part after "groups/".
-
3. Setting up the conversations integration (if you are setting up email, you can skip to topic 4)
-
In the Zendesk Admin Center, go to the conversations integrations section and create a new integration.
-
In the "Nome" (Name) field, add a name for the integration to make it easier to identify.
-
In the "URL do webhook" (Webhook URL) field, enter the webhook generated on the Painel da ClaudIA configuration screen.
-
Select the "Incluir usuário completo" (Include full user) and "Mensagem da Conversa" (Conversation Message) options.
-
Click "Guardar" (Save) to save it; there is no need to copy the information shown at this point.
-
Go to API keys and create a new key.
-
Copy the "ID da aplicação" (App ID), the "ID da chave" (Key ID) and the "chave secreta" (secret key)
-
Paste this information into the matching fields on the Helpdesk configuration screen.
4. Finishing the setup
-
After clicking "Salvar Integração" (Save Integration), check that the triggers are correct and that all the information is filled in.
-
Test the integration: send messages and check whether the tickets are being answered correctly.
Note:
In the email integration, you need to adjust the JSON of the "Cloud Humans | Webhook Trigger E-mail" trigger
{
"ticketId": "{{ticket.id}}",
"assigneeId": "{{ticket.assignee.id}}",
"title": "{{ticket.title}}",
"text": "{{ticket.latest_comment}}",
"commentId": "{{ticket.latest_comment.id}}",
"isPublic": "{{ticket.latest_comment.is_public}}",
"type": "{{ticket.via}}",
"sender": {
"id": "{{ticket.requester.id}}",
"name": "{{ticket.requester.name}}",
"email": "{{ticket.requester.email}}",
"role": "End-user"
},
"attachments": [ {% for attachment in ticket.latest_comment.attachments %} { "filename": "{{attachment.filename}}", "url": "{{attachment.url}}"} {% unless forloop.last %},{% endunless %} {% endfor %} ],
"comments": "{{ticket.comments}}"
}