Leia as perguntas frequentes
Novo
Suporte do Bitrix24
Inscrição e autorização
Como Começar?
Feed
Messenger
Página inicial: Vibe
Calendário
Bitrix24 Drive
E-mail
Grupos de trabalho
Tarefas e Projetos
CRM
CoPilot - IA no Bitrix24
Contact Center
Telefonia
CRM + Loja On-line
Sales Center (beta)
Análise CRM (beta)
Sales Intelligence (beta)
Criador de BI
Automação
Marketing
Bitrix24.Sites
Loja On-line (beta)
Gerenciamento do inventário
Empresa
Assinatura eletrônica para RH
Assinatura eletrônica
Base de conhecimento
Videoconferências em HD
Processos de negócio
Market (Aplicativos)
Assinatura
Enterprise
Configurações
Meu perfil
Aplicativo desktop
Bitrix24 On-premise
Questões Gerais
Novidades do Helpdesk (arquivo)

Suporte Bitrix24

Criar webhooks e aplicativos no Bitrix24

A seção Recursos para desenvolvedores reúne ferramentas para aprimorar seu Bitrix24. Aqui você pode:

A capacidade de criar webhooksUm webhook é um código de programa que permite rastrear alterações em um site e transferir dados sobre isso para outro site. e aplicativos está disponível apenas em alguns planos.
Planos e preços

Como criar um webhook

Na guia Casos de uso comum, há exemplos de cenários populares para a criação de webhooks. Crie um chatbot para informar os funcionários ou adicione um script de vendas ao formulário de chamada ativo. Se você não encontrar o que precisa, pode criar seu próprio webhook. Observe que qualquer usuário pode criar webhooks.

Selecione o caso de uso e prossiga com as configurações.

Webhook para API REST de chamada. Neste campo, é automaticamente gerada a chave secreta do webhook. A chave está disponível apenas para o criador do webhook. Quando um administrador edita um webhook de outro usuário, a chave secreta é redefinida e esse administrador se torna o proprietário desse webhook.
Webhooks. Guia de início rápido

Não compartilhe sua chave secreta do webhook com ninguém e evite usá-la em qualquer código ou script de página da web. Se pessoas não autorizadas virem esta chave, elas poderão obter acesso aos dados do seu Bitrix24.

Criador de pedido REST. Use o criador de pedidos para selecionar os métodos e parâmetros necessários e refinar as ferramentas. Você pode ler as descrições dos métodos e parâmetros e baixar um exemplo com parâmetros em PHP.
Descrição dos métodos da API REST

URL. Este campo inclui a URL gerada automaticamente a partir dos métodos e parâmetros configurados. Pode ser usada em sistemas externos para executar uma solicitação.

A URL consiste em vários parâmetros:

  • ********.bitrix24.com.br — o endereço da sua conta Bitrix24.
  • /rest — mostra que a operação é realizada via REST com webhooks.
  • /325 — este é o ID do usuário que criou o webhook.
  • /88u**********4qx — esta é a chave secreta. Usando esta chave, você pode visualizar, editar e excluir dados no Bitrix24.
  • /crm.lead.update — este é o método REST API que está sendo chamado.
  • .json — ao criar novos webhooks, o parâmetro é usado por padrão.
  • ?ID=42 — esses parâmetros são necessários para métodos específicos. Os parâmetros são indicados após um ponto de interrogação e são separados pelo caractere &.

Exemplo de execução do método update

Vamos considerar um exemplo de uso de métodos crm.***.update. Para esses métodos de CRM, excluindo processos inteligentes, aplica-se a regra geral: primeiro são passados os IDs e depois um array com valores alteráveis em fields.

Aqui está um exemplo de execução do método de atualização na barra de endereço do navegador: crm.***.update.json?id=1&fields[TITLE]=Test%20entity&fields[ASSIGNED_BY_ID]=1&fields[UF_CRM_1234567890]=TEST

Veja como construir solicitações de API REST para execução na barra de endereço do navegador: [método].json?[se passar um array, especifique o campo desta forma:]fields[[campo]]

Os parâmetros para vários métodos podem ser diferentes, portanto, verifique primeiro a descrição de cada método.

Para verificar sua solicitação, clique em Executar e visualize o resultado.

Atribuir permissões. Decida quais ferramentas do Bitrix24 podem ser acessadas com seu webhook. Por exemplo, o caso de uso Importe clientes só funcionará para CRM.


Aplicativos locais

Aplicativos locais são aqueles que você cria para o seu Bitrix24. Acesse a guia Casos de uso comum > Outro > Aplicativo local.
Aplicações locais. Guia de início rápido

Somente administradores de contas Bitrix24 podem criar aplicativos.

Como encontrar webhooks e aplicativos criados

Abra a guia Integrações. Aqui você pode ver:

  • nome dos webhooks e aplicativos,
  • quais eventos eles acionam,
  • a quais ferramentas eles têm acesso,
  • qual usuário os criou
Os administradores do Bitrix24 podem acessar todos os webhooks e aplicativos criados. Um usuário comum só pode acessar aqueles que ele criou.

Para ver apenas o que você precisa na lista de webhooks, clique em Configurações (⚙️) e selecione os campos. Se precisar editar ou excluir um webhook ou aplicativo, clique em Menu (≡).


Como visualizar estatísticas de aplicativos e webhooks

Abra a guia Estatísticas para visualizar o número de solicitações para cada webhook e aplicativo. Esta ferramenta irá ajudá-lo a verificar a carga de solicitações REST no Bitrix24.
Avaliar a carga REST no Bitrix24

Somente administradores podem acessar a seção de estatísticas de carga REST.

Para visualizar estatísticas de aplicativos e webhooks específicos, use o filtro. O período máximo para visualização das estatísticas é de 14 dias.

Para ver apenas as informações necessárias nas estatísticas, clique em Configurações (⚙️) e selecione os campos.


Destaques

  • A seção Recursos para desenvolvedores reúne ferramentas para aprimorar seu Bitrix24 usando webhooks e APIs REST.
  • Use scripts prontos para criar webhooks. Se não encontrar o que precisa, você pode criar seu próprio webhook.
  • Qualquer usuário pode criar webhooks.
  • Somente administradores podem criar aplicativos.
  • Você pode encontrar todos os webhooks e aplicativos criados na guia Integrações.
  • Visualize as estatísticas de solicitações de webhooks e aplicativos na guia Estatísticas.

Artigos recomendados:

Essa informação foi útil?
Assistência de Especialistas em Integração
Não é o que estou procurando
Texto complexo e incompreensível
Informações estão desatualizadas
Explicação muito breve, preciso de mais informações
Não gosto de como esta ferramenta funciona
Ir ao Bitrix24
Não tem uma conta? Crie grátis