Configurar a integração com o Jira
Caminho: Opa! Store → Jira → Instalar
Visão geral
O app Jira conecta o Opa! Suite aos seus projetos do Jira. Quando um item (cartão) muda de status no Jira, o Opa! Suite envia uma mensagem automática: para os atendimentos que citam aquele item, ou para grupos do chat interno. Assim, clientes e equipe acompanham o andamento das demandas sem sair do Opa! Suite.
A configuração tem três partes: criar o token de API no Jira, instalar o app no Opa! Suite e criar a automação do Jira que avisa o Opa! Suite. Depois, você define as regras de cada projeto.
O app é gratuito no Opa! Suite. O Jira segue o seu plano com a Atlassian. Só pode haver um app de gestão de projetos instalado.
Pré-requisitos
- Permissão para visualizar o Opa! Store no seu grupo de permissões.
- Uma conta do Jira Cloud, com permissão para criar regras de automação nos projetos.
- O endereço do seu Jira com
https://(ex.:https://suaempresa.atlassian.net). - Para notificar clientes: atendimentos com o link do item do Jira registrado nas observações.
Passo a passo
Criar o token de API no Jira
- Acesse a página de tokens de API da Atlassian e entre com a conta do Jira.
- Clique em Criar token de API, dê um nome a ele e escolha a data de expiração. O token vale de 1 a 365 dias (ajuda da Atlassian).
- Clique em Criar e copie o token.
Quando o token expira, a conexão com o Jira é interrompida. Crie um novo token e atualize o app em Cadastro.
Instalar o app no Opa! Suite
- Acesse Opa! Store → Jira e clique em Instalar. A janela Instalar Jira abre.
- Preencha os campos:
- Url: o endereço do seu Jira, com
https://, sem nada depois do domínio. - E-mail da conta: o e-mail da conta do Jira que criou o token.
- Chave API: o token copiado.
- Url: o endereço do seu Jira, com
- Clique em Instalar.
Criar a automação no Jira
- No Jira, abra o projeto e acesse Configurações do projeto → Automação e crie uma regra.
- Defina o gatilho, por exemplo, quando um item mudar de status.
- Adicione a ação Enviar solicitação da Web (Send web request) com:
- URL:
https://[endereço do seu Opa! Suite]/webhook/jira - Método: POST
- Corpo: os dados do item no formato da automação do Jira.
- URL:
- Salve e ative a regra.
O Opa! Suite só reage a itens de projetos que você configurou na aba Projetos.
Resultado esperado
O app aparece como Instalado e o botão Ver ajustes abre as abas Cadastro e Projetos. A aba Projetos lista os projetos do Jira da conta conectada.
Configurações disponíveis
Clique num projeto da lista para abrir as seções Informações do projeto, Notificar clientes e Notificar usuários internos. Em cada seção de notificação, ative a opção, ajuste os campos e salve.
Notificar clientes
| Campo | O que faz |
|---|---|
| Notificar atendimentos | Liga ou desliga o aviso aos atendimentos. |
| Status a notificar | Os status do Jira que disparam a mensagem. Obrigatório quando a notificação está ativa. |
| Mensagem a enviar | O texto enviado. Obrigatório quando a notificação está ativa. Aceita as variáveis abaixo. |
A mensagem vai para os atendimentos em atendimento que tenham o link do item nas observações. Ela sai em nome do atendente responsável pelo atendimento. Se o item mudou de nome no Jira, o Opa! Suite também considera os links antigos do histórico. No WhatsApp, o atendimento precisa estar dentro da janela de atendimento.
Notificar usuários internos
| Campo | O que faz |
|---|---|
| Notificar internamente | Liga ou desliga o aviso aos grupos. |
| Usuário que irá notificar | O usuário em nome de quem a mensagem é enviada nos grupos. |
| Status a notificar | Os status do Jira que disparam a mensagem. |
| Grupos a notificar | Os grupos do chat interno que recebem a mensagem. |
| Mensagem a enviar | O texto enviado. Aceita as variáveis abaixo. |
Veja como funcionam os grupos em Chat interno.
Variáveis da mensagem
| Variável | O que traz |
|---|---|
| Link do item | O endereço do item no Jira. |
| Identificador do item | O código do item (ex.: ABC-123). |
| Título do item | O resumo do item. |
| Status do item | O status atual. |
| Tipo do item | O tipo do item (ex.: Tarefa, Bug). |
O Opa! Suite compara o status do item, já sem acentos, com os status que você cadastrou. Por isso, cadastre os status sem acento (ex.: "Concluido" para o status "Concluído").
Problemas comuns
| Sintoma | O que verificar |
|---|---|
| A mensagem não chega a ninguém | Confira se a automação do Jira está ativa e aponta para /webhook/jira, se o projeto está configurado na aba Projetos e se a notificação está ativa. |
| O status do item está na lista e a mensagem não sai | Cadastre o status sem acento. |
| O cliente não recebeu | O link do item precisa estar nas observações de um atendimento em andamento. No WhatsApp, o atendimento precisa estar na janela de atendimento. |
| A lista de projetos não carrega, ou aparece que a integração tem problemas | Confira a Url, o E-mail da conta e a Chave API, e se o token não expirou. |
Boas práticas
- Cadastre só os status que importam para o cliente, para não gerar mensagens demais.
- Use as variáveis para a mensagem trazer o link e o status do item.
- Renove o token antes da data de expiração.