Um webhook é um método que permite que um aplicativo ou serviço da web envie informações quase em tempo real para outro serviço da web. A comunicação é ativada por um evento ou eventos específicos que você define. Em vez de verificar atualizações repetidamente, o sistema envia uma notificação assim que ocorre o evento de ativação.
No ArcGIS Online , webhooks podem ser criados para camadas de feição hospedadas, visualizações de camadas de feição hospedadas e tabelas hospedadas. Esses webhooks enviam cargas úteis para um receptor de webhook com base em ativadores de eventos definidos. O receptor é configurado para executar ações automatizadas, como notificar uma lista pré-definida de destinatários sobre as edições, exportar as informações sobre as edições para um aplicativo externo para criar um relatório de alterações ou executar scripts de controle de qualidade nos dados editados.
Os componentes deste canal de comunicação são os seguintes:
- Ativador de evento—Cada ativador de evento especifica as operações de API, executadas no serviço da feição de origem do item, que solicita o webhook. Quando um usuário executa uma operação que foi especificada como um ativador de evento, o webhook entrega essa informação (como uma carga útil) ao receptor do webhook. Você especifica os ativadores ao criar um webhook. Consulte Ativadores de eventos da camada de feição para os ativadores de eventos específicos que você pode definir.
- Carga útil—A carga útil contém as informações apropriadas para a ativação do evento. Consulte Cargas úteis do webhook da camada de feição para obter informações sobre o que está incluído em uma carga útil.
- Receptor do webhook—O receptor do webhook aceita a carga útil e envia informações para uma lista pré-definida de destinatários (usuários ou aplicativos). Por exemplo, ele pode enviar um e-mail ou uma mensagem de texto notificando o usuário de que a ativação do evento ocorreu, enviar as informações sobre a ativação do evento para um banco de dados externo para arquivamento ou executar um script nos dados com base na ativação do evento ocorrido.
Você pode usar receptores de serviços da web de terceiros ou serviços da web personalizados para receptores de webhook. Você deve configurar os receptores de webhook para se comunicarem por meio de uma conexão HTTPS para receber cargas úteis, e sua organização do ArcGIS Onlinedeve conseguir acessar os receptores antes de adicionar um webhook a um item. O receptor do webhook é acessado por meio da URL de carga útil que você especifica ao criar o webhook.
O receptor do webhook está configurado fora do ArcGIS Online. Após configurar o receptor, você pode criar um webhook.
Requisitos
Antes de criar um webhook para uma camada de feição, visualização ou tabela hospedada, o item deve atender aos seguintes requisitos:
- A configuração Acompanhar alterações nos dados (adicionar, atualizar, excluir feição) deve estar habilitada.
- O item não pode estar na lixeira .
Cada item pode ter até 10 webhooks.
Criação de webhook
Os tipos de membros da organização que podem criar e gerenciar webhooks para camadas de feição hospedadas, visualizações da camada de feição hospedada e tabelas hospedadas estão listados na tabela a seguir, juntamente com informações sobre onde eles podem gerenciar webhooks.
| Tipo de membro da organização | Onde webhooks podem ser gerenciados |
|---|---|
Membros do papel de administrador padrão ou membros de um papel personalizado que tem o conjunto de privilégios administrativos para criar e gerenciar webhooks. |
|
Proprietários do item |
|
Membros de um grupo de atualização compartilhado com o qual o item foi compartilhado | A guia Configurações de uma camada de feição hospedada, visualização ou página de item da tabela — O membro do grupo pode criar e gerenciar webhooks para o item específico. |
Siga as instruções apropriadas ao seu papel na organização para criar um webhook:
- Administrador da organização
- Proprietário do item ou membro de um grupo de atualização compartilhado com o qual o item é compartilhado