Chaves API
As chaves de API permitem acesso automatizado aos dados do seu CRM, sincronizam dados com outros sistemas e criam integrações ou soluções personalizadas.
Criar uma Chave de API.
- Vá para Configurações → APIs & Webhooks
- Clique em + Criar chave no canto superior direito
- Configure sua chave de API:
- Nome: Dê um nome descritivo à sua chave de API
- Data de Expiração: Defina quando a chave deve expirar
- Clique em Salvar para gerar sua chave de API
- Importante: Copie e armazene sua chave de API imediatamente, ela é mostrada apenas uma vez
Uma vez criada, sua chave de API fornece acesso à sua documentação de API personalizada e a um playground onde você pode testar endpoints com seu modelo de dados real.
Como sua chave de API oferece acesso a informações sensíveis, você não deve compartilhá-la com serviços nos quais não confia totalmente. Se vazada, alguém pode usá-la maliciosamente. Se a segurança da sua chave de API for comprometida, desabilite-a imediatamente e gere uma nova.
Gerenciar Chaves de API
Regenerar uma Chave de API:
- Vá para Configurações → APIs & Webhooks
- Clique na chave de API que você deseja regenerar
- Clique no botão Regenerar
- Copie e armazene a nova chave da API imediatamente
Excluir Chave API:
- Encontre a chave da API na sua lista
- Clique na chave para abrir seus detalhes
- Clique em Excluir para remover permanentemente
Webhooks
Webhooks permitem atualizações imediatas para o seu URL especificado sobre alterações ou eventos relacionados aos dados de seus clientes.
Por exemplo, quando uma Oportunidade se move para “Fechada Ganha”, um webhook pode automaticamente acionar a criação de fatura em seu sistema de contabilidade. Observe que esse tipo de automação também pode ser alcançado usando o recurso Workflows de Twenty que oferece gatilhos baseados em atualizações de campo para automação interna.
Os Webhooks são ideais para integração com sistemas externos, enquanto os Workflows suportam automação interna e conexões de ferramentas externas por meio de gatilhos de webhook, nós de código e nós HTTP.
Criar Webhook
- Vá para Configurações → APIs & Webhooks → Webhooks
- Clique em + Criar webhook
- Insira o URL do seu webhook (onde você deseja receber notificações)
- Clique em Salvar
Seu webhook começará imediatamente a receber notificações em tempo real sobre alterações nos dados do seu CRM.
Gerenciar Webhooks
Excluir Webhook:
- Vá para Configurações → APIs & Webhooks → Webhooks
- Encontre o webhook que você deseja remover
- Clique no webhook
- Clique em Excluir e confirme no popup
Editar um Webhook:
- Clique no webhook que você deseja modificar
- Atualize o URL ou outras configurações
- Clique em Salvar para aplicar alterações
