Gerenciar webhooks

Como administrador, você pode atualizar e gerenciar webhooks atualizando sua configuração (como atualizar os ativadores de eventos nos quais o webhook está inscrito), como também, desabilitando e excluindo webhooks configurados anteriormente.

Anotação:

Nesta versão, os webhooks de serviço são recursos beta. Enquanto estiverem na versão beta, esses recursos poderão ter problemas conhecidos de desempenho ou qualidade e não serão suportados pelo Esri Technical Support. A documentação da API beta para os webhooks de serviço está disponível no PDF Guia de API do administrador de webhooks de serviço . Para mais informações sobre recursos beta no ArcGIS Enterprise, consulte Recursos beta.

Atualizar webhooks

Você pode atualizar os parâmetros configurados para webhooks após a criação. As seções abaixo descrevem como atualizar propriedades para webhooks da organização, serviço de geoprocessamento e serviço da feição.

Atualizar webhooks da organização

Para atualizar as propriedades do webhook da sua organização, siga estas etapas.

Anotação:

Para visualizar um exemplo de solicitação POST que atualiza a configuração de um webhook, consulte a documentação Atualizar Webhook de REST API.

1. Navegue até o ArcGIS Portal Directory e entre como um membro com um papel de administrador.

   Webhooks podem ser criados e gerenciados por administradores ou por membros que receberam o papel de administrador padrão.

   https://machine.domain.com/webadaptor/sharing/rest

   Após registrar, o parâmetro de recurso do Usuário para sua conta aparece.

2. Clique no hiperlink ID da Organização ou faça uma solicitação no formulário a seguir para acessar a página de recursos do Portal Self:
   https://machine.domain.com/webadaptor/sharing/rest/portals/self

3. Role até a parte inferior de parâmero do recurso Próprio e clique em Webhook > [Webhook] > Atualizar Webhook onde [Webhook] representa ID ou nome de um webhook específico para acessar a operação Atualizar Webhook.
4. Uma vez no parâmetro Atualizar Webhook, modifique as seguintes informações:
   1. Para atualizar o nome do webhook, forneça um nome exclusivo para o webhook na caixa de texto Nome.
   2. Se você estiver usando um novo receptor de webhook ou precisar atualizar a URL de carga útil para um receptor existente, forneça a nova URL na caixa de texto URL de Carga Útil.

      A URL de carga útil será consultada enquanto o webhook estiver sendo atualizado para garantir que uma conexão bem-sucedida possa ser feita entre o receptor e o portal ArcGIS Enterprise. Um exemplo 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

   3. Opcionalmente, adicione uma string alfanumérica que atue como um segredo para o webhook ou atualize um segredo pré-existente, que pode ser usado para autenticar mensagens de webhook com o receptor. Forneça o segredo novo ou atualizado na caixa de texto Segredo (Opcional).
   4. Opcionalmente, atualize as informações de desativação do webhook na caixa de texto Propriedades de Configuração.

      Por padrão, o webhook será desativado se ocorrerem cinco falhas ao longo de cinco dias.

   5. Para atualizar os ativadores de eventos de um webhook ou optar por receber webhooks para todos os ativadores de eventos, selecione uma das seguintes opções:
      • Clique em Deixe-me definir manualmente para modificar a lista de eventos do ativador que serão usados para este webhook na caixa de texto Envie-me alterações para estes eventos separadas por vírgula. Por exemplo, para se inscrever em todos os eventos pertencentes a um grupo específico em sua organização, forneça um ativador de evento semelhante ao demonstrado abaixo, onde [groupID] representa o ID único associado a um grupo específico:
        /groups/[groupID]/update

      • Clique em Envie-me tudo para assinar todos os ativadores de eventos com suporte e receber notificações para cada evento à medida que ocorrem.
5. Após os parâmetros acima serem configurados, clique em Atualizar Webhook para enviar a solicitação e aplicar as alterações.

Atualizar webhooks do serviço de geoprocessamento

Para atualizar as propriedades de um webhook do serviço de geoprocessamento, siga estas etapas.

Anotação:

Para visualizar um exemplo de solicitação POST que atualiza a configuração de um webhook do serviço de geoprocessamento, consulte a documentação beta de REST API no Guia de API do administrador de webhooks de serviço .

1. Navegue até o ArcGIS Server Administrator Directory e entre como membro com os privilégios administrativos apropriados atribuídos a eles.

   Webhooks podem ser criados e gerenciados somente por administradores que tenham o privilégio de administrador Atualizar, Excluir, Segurança e Infraestrutura ou Servidores atribuídos a eles ou que tenham recebido o papel de administrador padrão.

   https://machine.domain.com/webadaptor/admin

2. Após entrar, navegue até a operação Editar para um serviço de geoprocessamento clicando em Serviços > [ServiceName] > Webhooks > [Webhook] > Editar, onde [ServiceName] representa o serviço de geoprocessamento afetado e [Webhook] representa o webhook que será atualizado. Para serviços alojados em pastas específicas, clique em Serviços > [FolderName] > [ServiceName] > Webhooks > [Webhook] > Editar, onde [FolderName] representa a pasta onde o serviço está localizado.
3. No parâmetro Editar, modifique as seguintes informações:
   1. Se atualizar o nome do webhook, forneça um nome exclusivo para o webhook na caixa de texto Nome. O nome fornecido pode conter apenas valores alfanuméricos, pois o uso de caracteres especiais resultará em uma resposta de erro.
   2. Opcionalmente, adicione uma string alfanumérica que atue como um segredo para o webhook ou atualize um segredo pré-existente, que pode ser usado para autenticar mensagens de webhook com o receptor. Digite o segredo novo ou atualizado na caixa de texto Chave de Assinatura.
   3. Se você estiver usando um novo receptor ou precisar atualizar a URL de carga útil, forneça a nova URL na caixa de texto URL de Gancho, que será consultada enquanto o webhook estiver sendo atualizado para garantir que uma conexão bem-sucedida possa ser feita entre o receptor e a implantação do ArcGIS Server.

      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

   4. Para estabelecer um novo valor de tipo de mídia para o webhook, escolha uma das seguintes opções na caixa suspensa Tipo de Conteúdo:
      • application/json (padrão)
      • application/x-www-form-urlencoded
   5. Para atualizar o formato de uma carga útil, selecione uma das seguintes opções na caixa suspensa Formato de Carga Útil:
      • JSON (padrão)
      • PJSON
   6. Escolha habilitar ou desabilitar retornos de chamada para o webhook modificando o valor selecionado para o parâmetro Ativo. Para habilitar, selecione verdadeiro. Para desabilitar selecione falso.
4. Após os parâmetros acima serem configurados, clique em Editar para enviar a solicitação e aplicar as alterações.

Anotação:

Ao contrário dos webhooks de serviço da feição e da organização, os webhooks do serviço de geoprocessamento não têm ativadores de eventos definidos pelo usuário. Os webhooks do serviço de geoprocessamento entregam cargas úteis assim que um trabalho de geoprocessamento é concluído. Para mais informações sobre as cargas úteis entregues para serviços de geoprocessamento, consulte o tópico Cargas Úteis.

Atualizar webhooks de serviço da feição

Para atualizar as propriedades de um webhook de serviço da feição, siga estas etapas.

Anotação:

Para visualizar um exemplo de solicitação POST que atualiza uma propriedade de webhook do serviço da feição, consulte a documentação beta de REST API no Guia de API do administrador de webhooks de serviço .

1. Navegue até o ArcGIS Server Administrator Directory e entre como membro com os privilégios administrativos apropriados atribuídos a eles.

   Webhooks podem ser criados e gerenciados somente por administradores que tenham o privilégio de administrador Atualizar, Excluir, Segurança e Infraestrutura ou Servidores atribuídos a eles ou que tenham recebido o papel de administrador padrão.

   https://machine.domain.com/webadaptor/admin

2. Após conectado, navegue até o recurso Webhooks para um serviço da feição clicando em Serviços > [ServiceName] > Webhooks > Criar, onde [ServiceName] representa o serviço para o qual o webhook será criado. Para serviços alojados em pastas específicas, clique em Serviços > [FolderName] > [ServiceName] > Webhooks > Criar, onde [FolderName] representa a pasta onde o serviço está localizado.
3. Uma vez no parâmetro Criar Webhook, forneça as seguintes informações:
   1. Se atualizar o nome do webhook, forneça um nome exclusivo para o webhook na caixa de texto Nome. O nome fornecido pode conter apenas valores alfanuméricos, pois o uso de caracteres especiais resultará em uma resposta de erro.
   2. Para atualizar os ativadores de eventos de um webhook, liste os ativadores de eventos que serão usados para esse webhook na caixa de texto Alterar Tipo. Por exemplo, se você deseja atualizar o webhook a ser solicitado sempre que qualquer serviço da feição for criado, use o seguinte ativador de evento:

      FeaturesCreated

      Para visualizar uma lista de todos os ativadores de eventos com suporte para webhooks de serviço da feição, consulte o tópico Ativadores de eventos.
   3. Opcionalmente, adicione uma string alfanumérica que atue como um segredo para o webhook ou atualize um segredo pré-existente, que pode ser usado para autenticar mensagens de webhook com o receptor. Digite o segredo novo ou atualizado na caixa de texto Chave de Assinatura.
   4. Se você estiver usando um novo receptor ou precisar atualizar a URL de carga útil, forneça a nova URL na caixa de texto URL de Gancho, que será consultada enquanto o webhook estiver sendo atualizado para garantir que uma conexão bem-sucedida possa ser feita entre o receptor e a implantação do ArcGIS Server.

      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

   5. Para estabelecer um novo valor de tipo de mídia para o webhook, escolha uma das seguintes opções na caixa suspensa Tipo de Conteúdo:
      • application/json (padrão)
      • application/x-www-form-urlencoded
   6. Para atualizar o formato da carga útil, selecione uma das seguintes opções na caixa suspensa Formato de Carga Útil:
      • JSON (padrão)
      • PJSON
   7. Escolha habilitar ou desabilitar retornos de chamada para o webhook modificando o valor selecionado para o parâmetro Ativo. Para habilitar, selecione verdadeiro. Para desabilitar selecione falso.
   8. Ajuste o agendamento para webhooks modificando as informações de Segundos na caixa de texto Agendar. Para serviços da feição que passam por muitas edições frequentes, diminua o valor de Segundos para receber webhooks mais frequentes com menos informações de eventos na carga útil. Para serviços da feição que não sofrem alterações frequentes, aumente o valor da propriedade Segundos para receber webhooks menos frequentes com mais informações de eventos contidas na carga útil.

      O valor mínimo e padrão para agendamento é 20 segundos.

4. Após os parâmetros acima serem configurados, clique em Editar para enviar a solicitação e aplicar as alterações.

Desativar webhooks

Webhooks podem ser desativados manualmente ou, para webhooks da organização, após a política de desativação (definida durante a criação do webhook) ser atendida. Quando um webhook é desativado, o webhook é pausado e não consegue entregar cargas úteis quando elas são ativados. As seções abaixo descrevem como desativar a organização, o serviço de geoprocessamento e os webhooks de serviço da feição.

Desativar webhooks da organização

Para desativar um webhook da organização, siga estas etapas.

Anotação:

Para visualizar um exemplo de solicitação POST que desativa um webhook, consulte a documentação Desativar Webhook de REST API.

1. Navegue até o ArcGIS Portal Directory e entre como um membro com um papel de administrador.

   Webhooks podem ser criados e gerenciados por administradores ou por membros que receberam o papel de administrador padrão.

   https://machine.domain.com/webadaptor/sharing/rest

   Após registrar, o parâmetro de recurso do Usuário para sua conta aparece.

2. Clique no hiperlink ID da Organização ou faça uma solicitação no formulário a seguir para acessar a página de recursos do Portal Self:
   https://machine.domain.com/webadaptor/sharing/rest/portals/self

3. Role até a parte inferior de parâmero do recurso Próprio e clique emWebhook > [Webhook] > Desativar, onde [Webhook] reflete ID ou nome de um webhook específico para acessar a operaçãoDesativar.
4. Uma vez no parâmetro Desativar, clique em Desativar para pausar o webhook.

Desativar webhooks do serviço de geoprocessamento

Para desativar todos os webhooks configurados para um serviço de geoprocessamento, siga estas etapas.

Anotação:

Para visualizar um exemplo de solicitação POST que desativa todos os webhooks configurados para um serviço de geoprocessamento, consulte a documentação beta de REST API no Guia de API do administrador de webhooks de serviço .

1. Navegue até o ArcGIS Server Administrator Directory e entre como membro com os privilégios administrativos apropriados atribuídos a eles.

   Webhooks podem ser criados e gerenciados somente por administradores que tenham o privilégio de administrador Atualizar, Excluir, Segurança e Infraestrutura ou Servidores atribuídos a eles ou que tenham recebido o papel de administrador padrão.

   https://machine.domain.com/webadaptor/admin

2. Após registrado navegue até a operação deactivateAll para um serviço de geoprocessamento clicando em Serviços > [ServiceName] > Webhooks > deactivateAll, onde [ServiceName] representa o serviço de geoprocessamento específico. Para serviços alojados em pastas específicas, clique em Serviços > [FolderName] > [ServiceName] > Webhooks > deactivateAll, onde [FolderName] representa a pasta onde o serviço está localizado.
3. Uma vez no parâmetro deactivateAll, clique em Desativar Todos para pausar todos os webhooks configurados.

Desativar webhooks de serviço da feição

Para desativar todos os webhooks configurados para um serviço da feição, siga estas etapas.

Anotação:

Para visualizar um exemplo de solicitação POST que desativa todos os webhooks configurados para um serviço da feição, consulte a documentação beta de REST API no Guia de API do administrador de webhooks de serviço .

1. Navegue até o ArcGIS Server Administrator Directory e entre como membro com os privilégios administrativos apropriados atribuídos a eles.

   Webhooks podem ser criados e gerenciados somente por administradores que tenham o privilégio de administrador Atualizar, Excluir, Segurança e Infraestrutura ou Servidores atribuídos a eles ou que tenham recebido o papel de administrador padrão.

   https://machine.domain.com/webadaptor/admin

2. Após registrado navegue até a operação deactivateAll para um serviço da feição clicando em Serviços > [ServiceName] > Webhooks > deactivateAll, onde [ServiceName] representa o serviço da feição específico. Para serviços alojados em pastas específicas, clique em Serviços > [FolderName] > [ServiceName] > Webhooks > deactivateAll, onde [FolderName] representa a pasta onde o serviço está localizado.
3. Uma vez no parâmetro deactivateAll, clique em Desativar Todos para pausar todos os webhooks configurados.

Ativar webhooks

Enquanto um webhook estiver desativado, ele não poderá entregar cargas úteis. A reativação de um webhook reinicia o webhook e permite que ele entregue cargas úteis quando o webhook for solicitado em seguida. As seções abaixo descrevem como ativar webhooks da organização, serviço de geoprocessamento e serviço da feição anteriormente desativados.

Ativar webhooks da organização

Para ativar um webhook da organização, siga estas etapas.

Anotação:

Para visualizar um exemplo de solicitação POST que ativa um webhook, consulte a documentação Ativar Webhook de REST API.

1. Navegue até o ArcGIS Portal Directory e entre como um membro com um papel de administrador.

   Webhooks podem ser criados e gerenciados por administradores ou por membros que receberam o papel de administrador padrão.

   https://machine.domain.com/webadaptor/sharing/rest

   Após registrar, o parâmetro de recurso do Usuário para sua conta aparece.

2. Clique no hiperlink ID da Organização ou faça uma solicitação no formulário a seguir para acessar a página de recursos do Portal Self:
   https://machine.domain.com/webadaptor/sharing/rest/portals/self

3. Role até a parte inferior de parâmero do recurso Próprio e clique em Webhook > [Webhook] > Ativar, onde [Webhook] reflete ID ou nome de um webhook específico para acessar a operação Ativar.
4. Uma vez no parâmetro Ativar, clique em Ativar para reiniciar o webhook.

Ativar webhooks do serviço de geoprocessamento

Para ativar todos os webhooks configurados para um serviço de geoprocessamento, siga estas etapas.

Anotação:

Para visualizar um exemplo de solicitação POST que ativar todos os webhooks configurados para um serviço de geoprocessamento, consulte a documentação beta de REST API no Guia de API do administrador de webhooks de serviço .

1. Navegue até o ArcGIS Server Administrator Directory e entre como membro com os privilégios administrativos apropriados atribuídos a eles. .

   Webhooks podem ser criados e gerenciados somente por administradores que tenham o privilégio de administrador Atualizar, Excluir, Segurança e Infraestrutura ou Servidores atribuídos a eles ou que tenham recebido o papel de administrador padrão.

   https://machine.domain.com/webadaptor/admin

2. Após registrado navegue até a operação activateAll para um serviço de geoprocessamento clicando em Serviços > [ServiceName] > Webhooks > activateAll, onde [ServiceName] representa o serviço de geoprocessamento específico. Para serviços alojados em pastas específicas, clique em Serviços > [FolderName] > [ServiceName] > Webhooks > activateAll, onde [FolderName] representa a pasta onde o serviço está localizado.
3. Uma vez no parâmetro activateAll, clique em Ativar Todos para retomar todos os webhooks pausados.

Ativar webhooks de serviço da feição

Para ativar todos os webhooks configurados para um serviço da feição, siga estas etapas.

Anotação:

Para visualizar um exemplo de solicitação POST que ativa todos os webhooks configurados para um serviço da feição, consulte a documentação beta de REST API no Guia de API do administrador de webhooks de serviço .

1. Navegue até o ArcGIS Server Administrator Directory e entre como membro com os privilégios administrativos apropriados atribuídos a eles.

   Webhooks podem ser criados e gerenciados somente por administradores que tenham o privilégio de administrador Atualizar, Excluir, Segurança e Infraestrutura ou Servidores atribuídos a eles ou que tenham recebido o papel de administrador padrão.

   https://machine.domain.com/webadaptor/admin

2. Após registrado navegue até a operação activateAll para um serviço da feição clicando em Serviços > [ServiceName] > Webhooks > activateAll, onde [ServiceName] representa o serviço da feição específico. Para serviços alojados em pastas específicas, clique em Serviços > [FolderName] > [ServiceName] > Webhooks > activateAll, onde [FolderName] representa a pasta onde o serviço está localizado.
3. Uma vez no parâmetro activateAll, clique em Ativar Todos para retomar todos os webhooks pausados.

Excluir webhooks

Se um webhook criado anteriormente não for mais necessário, você poderá removê-lo permanentemente de sua organização excluindo-o. As seções a seguir descrevem como excluir webhooks da organização, serviço de geoprocessamento ou serviço da feição.

Excluir webhooks da organização

Para excluir um webhook da organização, siga estas etapas.

Anotação:

Para visualizar um exemplo de solicitação POST que exclui um webhook, consulte a documentação Excluir Webhook de REST API.

1. Navegue até o ArcGIS Portal Directory e entre como um membro com um papel de administrador.

   Webhooks podem ser criados e gerenciados por administradores ou por membros que receberam o papel de administrador padrão.

   https://machine.domain.com/webadaptor/sharing/rest

   Após registrar, o parâmetro de recurso do Usuário para sua conta aparece.

2. Clique no hiperlink ID da Organização ou faça uma solicitação no formulário a seguir para acessar o recurso Portal Self:
   https://machine.domain.com/webadaptor/sharing/rest/portals/self

3. Role até a parte inferior de parâmero do recurso Próprio e clique em Webhook > [Webhook] > Excluir, onde [Webhook] reflete ID ou nome de um webhook específico para acessar a operação Excluir.
4. Uma vez no parâmetro Excluir, clique em Excluir para remover permanentemente o webhook.

Excluir webhooks do serviço de geoprocessamento

Há duas maneiras de excluir webhooks do serviço de geoprocessamento. Você pode excluir todos os webhooks configurados para um serviço de geoprocessamento ou excluir um webhook individual. Para excluir webhooks do serviço de geoprocessamento, siga estas etapas.

Anotação:

Para visualizar um exemplo de solicitação POST que ativar todos os webhooks configurados para um serviço de geoprocessamento, consulte a documentação beta de REST API no Guia de API do administrador de webhooks de serviço .

1. Navegue até o ArcGIS Server Administrator Directory e entre como membro com os privilégios administrativos apropriados atribuídos a eles.

   Webhooks podem ser criados e gerenciados somente por administradores que tenham o privilégio de administrador Atualizar, Excluir, Segurança e Infraestrutura ou Servidores atribuídos a eles ou que tenham recebido o papel de administrador padrão.

   https://machine.domain.com/webadaptor/admin

2. Após registrado, navegue até o recurso Webhooks clicando em Serviços > [ServiceName] > Webhooks, onde [ServiceName] representa o serviço de geoprocessamento específico. Para serviços alojados em pastas específicas, clique em Serviços > [FolderName] > [ServiceName] > Webhooks, onde [FolderName] representa a pasta onde o serviço está localizado.
3. Uma vez no parâmetro Webhooks, opte por excluir todos os webhooks ou excluir um webhook específico.
   • Para excluir todos os webhooks configurados para um serviço de geoprocessamento, clique em deleteAll para acessar o parâmetro da operação. Uma vez lá, clique em Excluir Todos.
   • Para excluir um webhook específico, clique em [Webhook] > Excluir, onde [Webhook] representa a ID de um webhook. Uma vez no parâmetro da operação Excluir, clique em Excluir.

Excluir webhooks de serviço da feição

Há duas maneiras de excluir webhooks do serviço da feição. Você pode excluir todos os webhooks configurados para um serviço da feição ou excluir um webhook individual. Para excluir webhooks do serviço da feição, siga estas etapas.

Anotação:

Para visualizar um exemplo de solicitação POST que ativa todos os webhooks configurados para um serviço da feição, consulte a documentação beta de REST API no Guia de API do administrador de webhooks de serviço .

1. Navegue até o ArcGIS Server Administrator Directory e entre como membro com os privilégios administrativos apropriados atribuídos a eles.

   Webhooks podem ser criados e gerenciados somente por administradores que tenham o privilégio de administrador Atualizar, Excluir, Segurança e Infraestrutura ou Servidores atribuídos a eles ou que tenham recebido o papel de administrador padrão.

   https://machine.domain.com/webadaptor/admin

2. Após registrado, navegue até o recurso Webhooks clicando em Serviços > [ServiceName] > Webhooks, onde [ServiceName] representa o serviço da feição específico. Para serviços alojados em pastas específicas, clique em Serviços > [FolderName] > [ServiceName] > Webhooks, onde [FolderName] representa a pasta onde o serviço está localizado.
3. Uma vez no parâmetro Webhooks, opte por excluir todos os webhooks ou excluir um webhook específico.
   • Para excluir todos os webhooks configurados para um serviço da feição, clique em deleteAll para acessar o parâmetro da operação. Uma vez lá, clique em Excluir Todos.
   • Para excluir um webhook específico, clique em [Webhook] > Excluir, onde [Webhook] representa a ID de um webhook. Uma vez no parâmetro da operação Excluir, clique em Excluir.