As integrações de conversas ajudam as empresas a unificar mensagens de todos os canais, chatbots ou aplicativos de terceiros em uma única conversa e criar experiências interativas em todos os lugares.
- Um webhook.
- (Opcional) Um conjunto de chaves da API para interagir com a API pública com um escopo de integração. Para obter informações sobre a criação de chaves da API, consulte Uso de chaves da API de conversas.
Observação: as integrações de conversas eram conhecidas anteriormente como webhooks no painel do Sunshine Conversations.
Você pode criar integrações de conversas usando a página Integrações de Conversas na Central de administração.
Você também pode criar sua integração usando a curl ou o Postman.
Este artigo inclui as seções a seguir:
Criação e configuração de conversas na Central de administração
Na página Integrações de conversas, é possível:
Criação de uma nova integração de conversas
-
Na Central de administração, clique em
Aplicativos e integrações na barra lateral e selecione Integrações > Integrações de conversas. A página Integrações de conversas é exibida. Todas as conversas que já estavam criadas são mostradas na lista.
Se essa é a primeira vez que está criando uma integração na Central de administração, clique em Criar integração para visualizar a página Integração de conversas.
- Clique em Criar integração. A página Criar integração é exibida.
- Insira um nome específico para identificar a integração.
- Na seção Webhook, insira as informações a seguir:
-
URL do ponto de extremidade do webhook: a URL alvo. Quando ocorre um evento de gatilho, o webhook detecta o evento e envia os dados para a URL alvo. A URL alvo usa este formato:
https://www.yourdomain.com/path. - Dados do corpo do webhook: Use as caixas de seleção para indicar se deseja incluir o esquema do usuário e as informações do cliente e do dispositivo nos dados do webhook.
- Assinaturas do webhook: selecione os eventos sobre os quais deseja ser avisado.
-
URL do ponto de extremidade do webhook: a URL alvo. Quando ocorre um evento de gatilho, o webhook detecta o evento e envia os dados para a URL alvo. A URL alvo usa este formato:
- Clique em Salvar. A janela Copiar segredo compartilhado é exibida.
- (Opcional) Copie a ID do webhook e o segredo compartilhado. Esses são usados pelos desenvolvedores para adicionar outra camada de autenticação e não são obrigatórios.
- Clique em Next. A página de configuração da integração é exibida. Nela, é possível adicionar uma chave da API, se necessário.
Adição de uma chave da API
Na aba Chave da API, é possível configurar a autenticação para a integração. A chave da API identifica e autentica um aplicativo ou usuário e é composta de três itens:
- A ID do aplicativo identifica sua conta do Zendesk.
- A ID da chave quando usada com a chave secreta as credenciais são usadas para autenticar os JWTs e as chamadas da API.
- A chave secreta é a senha de autenticação.
Como criar e compartilhar uma chave da API
-
Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Integrações > Integrações de conversas. A página Integrações de conversas é exibida.
- Clique na aba Chave da API.
- Clique em Criar chave da API. Se você está criando a sua primeira chave, esse botão é exibido na parte inferior da página; se você já tiver criado uma chave, ele será exibido no canto superior direito.
- Na caixa de diálogo Criar nova chave, insira um nome de identificação para a chave e clique em Avançar.
- Na caixa de diálogo Copiar segredo compartilhado, clique em Copiar para cada ID e chave secreta para salvá-la na área de transferência e clique em Avançar. Você será redirecionado para a janela da API, onde você verá a nova chave na lista.
Se você gerar um nova chave, mas atingir o número máximo de 10, verá uma notificação pedindo que apague as chaves não utilizadas.
Como apagar uma chave não utilizada
- Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Integrações > Integrações de conversas.
- Clique na aba Chave da API.
- Passe o cursor sobre a chave que você deseja apagar, clique no menu de opções (
) e selecione Apagar.
Visualização, edição e exclusão de uma integração
Como trabalhar com uma integração existente
-
Na Central de administração, clique em Aplicativos e integrações na barra lateral e selecione Integrações > Integrações de conversas. A página Integrações de conversas é exibida.
- Passe o cursor sobre a integração que você deseja atualizar, clique no ícone de Opções (
) e selecione uma opção:
- View details: exibe a página de detalhes da integração, onde você pode visualizar as IDs do aplicativo, integração e webhook além de informações sobre segredos compartilhados, detalhes do webhook e chaves da API.
- Editar: abre a página Criar integrações, na qual você pode atualizar o nome da integração e os detalhes do webhook.
- Apagar: inicia o assistente de exclusão. Você pode cancelar e sair do assistente a qualquer momento.
Outros métodos de integração
Esses métodos estão disponíveis apenas para usuários com uma licença separada do Sunshine Conversations, mas não com a licença que vem com o Zendesk Suite Professional ou superior.
Como criar uma integração de conversas usando a curl
- Crie uma integração usando a API Create Integration e defina
typecomocustom. - Forneça os parâmetros necessários conforme especificado na API. O alvo é a URL do seu servidor e a lista de gatilhos determina quais eventos receber.
Como criar uma integração de conversas usando o Postman
- Crie uma integração usando a API Create Integration e defina
typecomocustom. - Baixe e instale o aplicativo do Postman.
- Baixe a Postman collection do Sunshine Conversations e configure seu ambiente.
- No Postman, selecione Smooch > Integrations > Create Integrations.
- Forneça os parâmetros necessários conforme especificado pelo seu tipo de integração.
Para obter mais informações sobre as APIs do Sunshine Conversations, consulte Integrações.
Consulte também os guias sobre envio e recebimento de mensagens. Você irá querer configurar webhooks usando as REST APIs.