Como administrador da organização, você pode configurar webhooks para que sua implantação do ArcGIS Enterprise seja notificada quando ocorrerem eventos específicos. As seções abaixo descrevem como configurar webhooks da organização e de serviço.
Pré-requisitos para criação de webhooks
Considere o seguinte antes de criar webhooks:
- Para usar webhooks da organização, sua organização deve estar usando ArcGIS Enterprise 10.7 ou posterior. Para usar webhooks do serviço, sua organização deve estar usando ArcGIS Enterprise 11.0 ou posterior.
- Para criar e gerenciar webhooks da organização, você deve receber o privilégio de webhooks da organização ou ser atribuído ao papel de administrador padrão.
- Para criar e gerenciar webhooks do serviço de geoprocessamento, você deve receber o privilégio de geoprocessamento ou ser atribuído ao papel de administrador padrão.
Anotação:
Os usuários atribuídos ao privilégio Geoprocessamento também exigirão que o privilégio Publicar camadas baseadas no servidor seja adicionado ao seu papel personalizado.
- Para criar e gerenciar webhooks do serviço da feição, você deve receber o privilégio da camada de feição ou ser atribuído ao papel de administrador padrão.
- Os receptores de webhook devem ser configurados para se comunicar por HTTPS. 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.
- Para configurar webhooks para um serviço da feição hospedado, o serviço deve incluir o recurso de Edição e ter o controle de rastreamento ativado sem sincronização.
- Para configurar webhooks para um serviço da feição não hospedado, os dados do geodatabase enterprise aos quais o serviço faz referência devem atender aos requisitos para alterar o rastreamento e seguir um dos seguintes padrões:
- É um serviço de feição não versionado com arquivamento habilitado e IDs globais.
- É um serviço de feição versionado de ramificação sem o Recurso de gerenciamento de versão habilitado, onde as edições são aplicadas diretamente às feições da versão padrão.
- É um serviço de feição versionado de ramificação com o recurso de gerenciamento de versão habilitado. Quando o recurso de gerenciamento de versão estiver habilitado, o serviço poderá criar um webhook que tenha o gatilho de evento FeaturesPosted, que invoca o webhook sempre que a operação post for executada no serviço.
Anotação:
O suporte para serviços de feição versionado de ramificação foi adicionado no ArcGIS Enterprise 11.3.
- Para configurar webhooks para um serviço de geoprocessamento, o serviço deve ser assíncrono.
Configurar webhooks da organização
Os webhooks da organização permitem assinar ativadores para eventos associados a seus itens, grupos e usuários do portal ArcGIS Enterprise.
Criar um webhook da organização
Para criar um webhook da organização por meio do site de portal do ArcGIS Enterprise, siga estas etapas:
- Verifique se você está conectado como administrador padrão ou membro de um papel personalizado com o privilégio de webhooks da organização.
- Navegue até Organização > Configurações > Webhooks.
- Em Webhooks da organização, clique em Criar webhook.
- Na janela Criar webhook, faça o seguinte:
- Forneça um nome exclusivo para o webhook na caixa de texto Nome.
- Selecione um tipo de webhook no menu suspenso Tipo.
- Selecionar Todos o inscreve em todos os ativadores de eventos suportados. Você receberá notificações para cada evento conforme eles ocorrem.
- Selecionar Itens, Usuários, Grupos ou Papéis permite definir manualmente em quais ativadores de eventos deseja se inscrever.
- Se você selecionar um tipo de webhook diferente de Todos, um menu suspenso adicional aparecerá, relativo ao tipo de webhook escolhido. Por exemplo, se você selecionou Itens para o tipo de webhook, o menu suspenso Itens aparecerá, permitindo que você selecione um item específico que o webhook monitorará.
- Selecione ativadores de eventos no menu suspenso Eventos. Por exemplo, se você deseja que o webhook seja solicitado quando um item específico for publicado, selecione /items/<ID do item>/publish.
- Selecione um tipo de receptor de webhook.
- Se você selecionar URL do Webhook, forneça a URL de carga útil para o receptor de webhook. Um exemplo de URL de carga útil é demonstrado abaixo:
https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow
- Se você selecionar Notebook, escolha o notebook que será executado quando o webhook for ativado.
Anotação:
Se a opção Notebook não estiver disponível, um Notebook Server não foi configurado com seu portal. Se a opção estiver disponível, mas não puder ser selecionada, você não é proprietário de nenhum notebook adequado para configurar webhooks. Você deve ser proprietário de item do notebook que será usado para o webhook.
- Se você selecionar URL do Webhook, forneça a URL de carga útil para o receptor de webhook. Um exemplo de URL de carga útil é demonstrado abaixo:
- Opcionalmente, defina um valor secreto para o webhook na caixa de texto Segredo (Opcional). O valor secreto será usado para gerar uma assinatura que será incluída nos cabeçalhos de carga útil do webhook. O receptor do webhook pode usar essa assinatura para determinar se a mensagem é confiável.
- Clique em Criar webhook.
Configurar parâmetros avançados para webhooks da organização
As configurações avançadas aplicadas aos webhooks da sua organização permitem personalizar ainda mais o desempenho dos webhooks, como especificar o número de tentativas de entrega, tempo de notificação e tempo entre tentativas de entrega.
Para definir propriedades avançadas por meio do ArcGIS Enterprise, faça o seguinte:
- Entre na sua organização como administrador padrão ou membro de um papel personalizado com o privilégio de webhooks da organização.
- Navegue até Organização > Configurações > Webhooks.
- Em Webhooks da organização, clique em Configurações de webhook avançadas.
- Na janela Configurações de webhook avançadas, faça o seguinte:
- Defina um valor para Número de tentativas de entrega.
Esse valor especifica o número de tentativas que serão feitas para entregar as cargas úteis do webhook. Navegue até o ArcGIS Enterprise e entre como um membro com um papel de administrador. O valor das tentativas deve ser um número inteiro entre 0 e 5.
- Defina um valor para Tempo limite da notificação.
Esse valor especifica o tempo, em segundos, que o portal ArcGIS Enterprise aguardará para receber uma resposta de um receptor. Por padrão, o portal ArcGIS Enterprise aguardará 10 segundos. O valor para o número de segundos que o portal ArcGIS Enterprise aguardará deve ser um número inteiro entre 0 e 60 segundos.
- Defina um valor para Tempo decorrido da notificação
Esse valor especifica a quantidade de tempo, em segundos, entre cada tentativa de entrega de carga útil. Por padrão, o portal ArcGIS Enterprise tentará entregar outra carga útil após 5 segundos se a tentativa anterior falhar, até que o número de tentativas especificado em Número de tentativas de notificação seja atingido.
- Defina um valor para Número de tentativas de entrega.
- Após as configurações acima serem definidas, clique em Salvar.
As propriedades atualizadas serão aplicadas a cada webhook da organização configurado.
Configurar webhooks de serviço
Os webhooks de serviço permitem assinar ativadores para eventos associados aos serviços de feição da sua organização ou quando os trabalhos do serviço de geoprocessamento são concluídos.
Criar um webhook de serviço
Para criar um webhook para um serviço de geoprocessamento ou um serviço da feição, siga estas etapas:
- Entre na sua organização como administrador padrão ou membro de um papel personalizado com privilégios administrativos para criar e gerenciar webhooks de serviço.
Anotação:
Os membros atribuídos ao papel de publicador não poderão criar ou gerenciar webhooks de serviço no site do portal ArcGIS Enterprise e precisarão executar esses fluxos de trabalho usando a API administrativa.usando a API administrativa. - Navegue até Organização > Configurações > Webhooks.
- Em Webhooks de serviço, clique em Criar webhook.
- Na janela Criar webhook, faça o seguinte:
- Forneça um nome exclusivo para o webhook na caixa de texto Nome.
- Selecione um serviço no menu suspenso Serviço.
Anotação:
Selecionar um serviço de geoprocessamento definirá o evento como Serviço concluído. Selecionar um serviço da feição habilitará o menu suspenso Evento.
- Se você selecionar um webhook de serviço da feição, selecione um ativador de eventos no menu suspenso Eventos. Por exemplo, se você desejar que o webhook seja invocado quando uma edição incluir um novo anexo, selecione AttachmentsCreated.
- Forneça a URL de carga útil para o receptor de webhook na caixa de texto URL do Webhook. Um exemplo de URL de carga útil é demonstrado abaixo:
https://app.logic.azure.com:443/workflows/b688528a36e246279dc050f936e5ebd4/triggers/manual/paths/invoke?api-version=2016-06-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=nHP-LBo9x-nSgMi11DSDuwRIUiJr-8yKGCy7OYaT_ow
- Opcionalmente, defina um valor secreto para o webhook na caixa de texto Segredo (Opcional). O valor secreto será usado para gerar uma assinatura que será incluída nos cabeçalhos de carga útil do webhook. O receptor do webhook pode usar essa assinatura para determinar se a mensagem é confiável.
- Clique em Criar webhook.
Configurar parâmetros avançados para webhooks de serviço
As configurações avançadas aplicadas aos seus webhooks de serviço permitem personalizar ainda mais o desempenho dos webhooks, como especificar o número de tentativas de entrega, tempo de notificação e tempo entre tentativas de entrega.
Para definir propriedades avançadas por meio do ArcGIS Enterprise, faça o seguinte:
- Entre na sua organização como administrador padrão ou membro de um papel personalizado com privilégios administrativos para criar e gerenciar webhooks de serviço.
Anotação:
Os membros atribuídos ao papel de publicador não poderão criar ou gerenciar webhooks de serviço no site do portal ArcGIS Enterprise e precisarão executar esses fluxos de trabalho usando a API administrativa.usando a API administrativa. - Navegue até Organização > Configurações > Webhooks.
- Em Webhooks de serviço, clique em Configurações de webhook avançadas.
- Na janela Configurações de webhook avançadas, faça o seguinte:
- Defina um valor para Número de tentativas de entrega.
Esse valor especifica o número de tentativas que serão feitas para entregar as cargas úteis do webhook. Por padrão, o sistema tentará entregar cargas úteis 3 vezes. O valor das tentativas deve ser um número inteiro entre 0 e 5.
- Defina um valor para Tempo limite da notificação.
Esse valor especifica o tempo, em segundos, que o sistema aguardará para receber uma resposta de um receptor. Por padrão, o sistema aguardará 10 segundos. O valor deve ser um número inteiro entre 0 e 60 segundos.
- Defina um valor para Tempo decorrido da notificação
Esse valor especifica a quantidade de tempo, em segundos, entre cada tentativa de entrega de carga útil. Por padrão, o sistema tentará entregar outra carga útil após 5 segundos se a tentativa anterior falhar, até que o número de tentativas especificado em Número de tentativas de notificação seja atingido.
- Defina um valor para o Número de dias passados.
Este valor especifica o número de dias em que uma quantidade específica de falhas pode ocorrer antes que o webhook seja desativado. Por padrão, o sistema aceitará um número específico de falhas (especificado em Número máximo de falhas) ao longo de 5 dias. O valor deve ser um número inteiro entre 1 e 30.
- Defina um valor para Número máximo de falhas.
Este valor especifica o número de falhas que podem ocorrer durante um número específico de dias antes que o webhook seja desativado. Por padrão, o sistema aceitará 5 falhas ao longo de um número de dias (especificado em Número de dias passados) antes que os webhooks sejam desativados. O valor deve ser um número inteiro entre 1 e 30.
- Defina um valor para Número de tentativas de entrega.
- Após as configurações acima serem definidas, clique em Salvar.
As propriedades atualizadas serão aplicadas a cada webhook de serviço configurado.