Skip To Content

Principais conceitos para webhooks

Um webhook fornece a outros aplicativos informações orientadas a eventos, entregues como uma solicitação de HTTPS que pode ser usada para criar fluxos de trabalho automatizados e integrados. Alguns dos principais conceitos sobre fluxos de trabalho de webhook do ArcGIS Enterprise são descritos com mais detalhes nas seções a seguir.

Ativador de evento

Um ativador de evento especifica as operações de API que solicitarão seu webhook. Os webhooks de serviço da feição e da organização oferecem suporte a uma variedade de ativadores de evento nos quais você pode se inscrever. Por exemplo, você pode definir o webhook de sua organização para ser ativado quando um grupo específico for atualizado ou, para um webhook de serviço da feição, você pode optar por ativar o webhook quando a definição de um serviço da feição for atualizada. Os webhooks do serviço de geoprocessamento, no entanto, não usam uma lista de ativadores de eventos que os usuários podem assinar. Em vez disso, os webhooks do serviço de geoprocessamento retornam cargas úteis sempre que um trabalho do serviço de geoprocessamento é concluído. Para obter mais informações sobre a lista com suporte de ativadores de eventos para webhooks de serviço da feição e da organização, consulte o tópico Ativadores de eventos.

Carga útil

Quando um usuário executa uma operação que foi especificada como um ativador de evento, o webhook entrega as informações do evento, também conhecidas como carga, para a URL de carga especificada. As informações do evento para cada tipo de webhook são entregues em um esquema JSON semelhante, contendo as informações do evento e quando o evento ocorreu, embora a estrutura de carga útil e as propriedades retornadas para webhooks da organização e do serviço variem de acordo com o tipo de webhook. Para saber mais sobre as cargas úteis para cada tipo de webhook, consulte Cargas Úteis.

URL de carga útil

Após um webhook ser solicitado, a carga útil será entregue a uma URL específica, geralmente fornecida pelo receptor do webhook. A URL de carga útil é fornecida ao configurar um webhook e é verificada durante a criação para garantir que o receptor seja alcançável pelo ArcGIS Enterprise com uma solicitação de POST do HTTPS

Receptores

As cargas úteis são entregues aos receptores de webhook, que recuperam a carga útil e comunicam que o evento ocorreu de volta aos administradores ou membros da organização. Os receptores de webhooks devem ser configurados para se comunicarem através de uma conexão HTTPS para receber cargas úteis e serem acessíveis peloArcGIS Enterprise. Há algumas opções com suporte para receptores, como receptores de serviços da web de terceiros (Microsoft Power Automate, Zapier, e IFFT), serviços da web personalizados, ArcGIS Notebook Server, e ArcGIS Workflow Manager. Para obter exemplos de como criar serviços da web personalizados ou começar a usar receptores de terceiros, consulte o Repositório de webhook. Para saber mais sobre como criar webhooks doNotebook Server Workflow Manager, consulte Automatizar fluxos de trabalho com ArcGIS Notebooks e Criar trabalhos com webhooks, respectivamente.