1. O que são Webhooks?

2. Como configurar Webhooks no Artia?

2.1 Como funcionam as ações da tela?

2.3 Quais são os Principais Campos e Parâmetros?

3. Documentação de Eventos e Payloads

1. O que são Webhooks?
Webhooks são mecanismos que permitem que um sistema notifique automaticamente outro sistema quando um evento relevante ocorre. Em vez de realizar consultas constantes para verificar mudanças, o webhook envia uma mensagem imediata assim que algo acontece, funcionando como um alerta em tempo real. 

Eles são utilizados para manter diferentes sistemas integrados, conectados e atualizados de forma automatizada. Com isso, processos se tornam mais rápidos, eficientes e sincronizados, eliminando a necessidade de verificações manuais ou frequentes. 

2. Como configurar Webhooks no Artia?

Ao entrar nas configurações do usuário, você verá a área de Webhooks, onde é possível cadastrar novas URLs e também consultar todas as que já estão configuradas.

Figura 1 – Configuração Webhooks 

Ao selecionar Adicionar, um menu lateral será exibido, permitindo cadastrar uma nova URL. Nesse mesmo painel, você também pode editar, duplicar, redefinir a chave ou remover a URL, de acordo com o que precisar.

Figura 2 – Tela de configuração do Webhook para adicionar uma nova URL 

Ao criar ou editar uma URL, serão exibidas as opções para preencher o Nome e selecionar o Evento, no qual você poderá escolher entre: Criar atividade, Editar atividade, Apagar atividade, Criar projeto, Editar Projeto e Apagar projeto.  Esses eventos determinam quais ações do sistema irão gerar o envio de informações ao usuário. É possível marcar apenas um deles ou ativar todos, conforme a necessidade.

Na mesma tela, também é necessário informar a URL de destino, que será utilizada para receber os dados sempre que um dos eventos escolhidos for disparado.

Depois de preencher e conferir as informações, basta clicar em Salvar para concluir a configuração.

Figura 3 - Modal de criação 

Ao salvar o sistema dispara uma mensagem informando o usuário que foi salvo com sucesso e a lista é atualizada com a URL adicionada. 

Figura 4 – Mensagem de sucesso ao salvar configuração de Webhook 

2.1 Como funcionam as ações da tela?

+ Adicionar: Abre o modal para configuração da URL com os campos Nome, Evento, URL e Chave.

Editar: Permite alterar os dados da URL. 

Figura 5 - Botão de editar

Copiar: Copia a chave do registro.

Figura 6 - Botão de copiar

Resetar: Permite disponibilizar a visão para outros usuários.

Figura 7 - Botão de disponibilizar a visão

Excluir: Remove a URL selecionada.

Figura 8 - Botão de remover a URL.

Importante: Não é possível recuperar este registro.

2.3 Quais são os Principais Campos e Parâmetros?

Nome: Permite adicionar ou editar o nome da URL. 

Evento: Neste campo o usuário seleciona uma ou todos os eventos disponíveis Criar Atividade, Editar Atividade, Apagar Atividade, Criar projeto, Editar projeto e Apagar projeto, Criar apontamento, Editar apontamento e Apagar apontamento, Editar ordem de serviço, Excluir ordem de serviço, Criar lançamento financeiro, Editar lançamento financeiro, Excluir lançamento financeiro.

Chave: Este campo será preenchido pelo artia com a informação de chave com a opção de resetar caso necessário. 

3. Eventos e Payloads

Para entender como funciona a comunicação, o envio de dados e as operações relacionadas às atividades, acesse a documentação completa no link abaixo.

Nela, você encontrará informações sobre:

• Como acontece a comunicação
• Como funciona o cabeçalho da entrega
• Criação, edição e exclusão de atividades
• Dados de atividades e de usuários

👉 Acesse a documentação completa:
https://developers.artia.com/#50fbc912-d840-4e8b-aff4-764ed3116875

Após esta explicação ainda restam dúvidas? Então fale diretamente com um de nossos consultores no chat do https://artia.com/ ou através do e-mail: [email protected]