Neste artigo:
- O que são Webhooks?
- Como configurar Webhooks no Artia?
- Quais são as ações disponíveis na tela?
- Quais são os principais campos e parâmetros?
- Documentação de Eventos e Payloads
1. O que são Webhooks?
Webhooks são mecanismos que permitem que um sistema notifique automaticamente outro 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, tornando os processos mais rápidos, eficientes e sincronizados, sem necessidade de verificações manuais ou frequentes.
2. Como configurar Webhooks no Artia?
Acesse as configurações da organização e localize a área de Webhooks, onde é possível cadastrar novas URLs e consultar todas as que já estão configuradas.
Configuração de Webhooks
Clique em Adicionar para abrir o menu lateral de cadastro. Nesse painel, também é possível editar, duplicar, redefinir a chave ou remover URLs existentes.
Tela de configuração para adicionar uma nova URL
Ao criar ou editar uma URL, preencha as seguintes informações:
- Nome: identifica a configuração do Webhook
- Evento: escolha um ou mais eventos que irão disparar o envio de dados. Os eventos disponíveis são: Criar atividade, Editar atividade, Apagar atividade, Criar projeto, Editar projeto, Apagar projeto, Criar apontamento, Editar apontamento, Apagar apontamento, Editar ordem de serviço, Excluir ordem de serviço, Criar lançamento financeiro, Editar lançamento financeiro e Excluir lançamento financeiro
- URL: endereço de destino que receberá os dados sempre que um dos eventos escolhidos for disparado
Após preencher e conferir as informações, clique em Salvar.
Modal de criação do Webhook
Ao salvar, o sistema exibirá uma mensagem de sucesso e a lista será atualizada com a URL adicionada.
Mensagem de sucesso ao salvar
3. Quais são as ações disponíveis na tela?
- + Adicionar: abre o modal para configuração de uma nova URL com os campos Nome, Evento, URL e Chave.
- Editar: permite alterar os dados de uma URL já cadastrada.
- Copiar: copia a chave do registro.
- Resetar: redefine a chave da URL selecionada.
- Excluir: remove a URL selecionada.
⚠️ Importante
A exclusão é permanente e não pode ser desfeita.
4. Quais são os principais campos e parâmetros?
- Nome: define o nome de identificação da configuração do Webhook.
- Evento: permite selecionar um ou mais eventos que irão disparar o envio de dados. Os eventos disponíveis são: Criar Atividade, Editar Atividade, Apagar Atividade, Criar Projeto, Editar Projeto, Apagar Projeto, Criar Apontamento, Editar Apontamento, Apagar Apontamento, Editar Ordem de Serviço, Excluir Ordem de Serviço, Criar Lançamento Financeiro, Editar Lançamento Financeiro e Excluir Lançamento Financeiro.
- Chave: preenchida automaticamente pelo Artia. Pode ser redefinida clicando em Resetar, caso necessário.
5. Documentação de 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 pelo 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
Acessar documentação completa de Eventos e Payloads
Ainda tem dúvidas? Fale com um de nossos consultores pelo chat em artia.com ou pelo e-mail [email protected].