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.

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 de organização e serviço.

Atualizar webhooks da organização

Para atualizar um webhook da organização por meio do site de portal do ArcGIS Enterprise, siga estas etapas:

1. Verifique se você está conectado como administrador padrão ou membro de um papel personalizado com privilégios administrativos para criar e gerenciar webhooks da organização.
2. Navegue até Organização > Configurações > Webhooks.
3. Em Webhooks da Organização, localize o webhook que deseja atualizar.
4. Clique no botão Opções e clique em Editar.
5. Na janela Editar webhook, modifique o seguinte:
   1. Para atualizar o nome do webhook, forneça um nome exclusivo para o webhook na caixa de texto Nome.
   2. Para atualizar o tipo de webhook, clique no menu suspenso Tipo e selecione um novo tipo de webhook.
      • 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 eventos do ativador deseja se inscrever.
   3. 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á.
   4. Para atualizar os ativadores de eventos, clique no menu suspenso Eventos e selecione um novo evento do ativador. Por exemplo, se você deseja que o webhook seja solicitado quando um item específico for publicado, selecione /items/<ID do item>/publish.
   5. Caso seja necessário atualizar a URL de carga útil, selecione URL do Webhook e forneça a nova URL de carga útil para o receptor de webhook.
   6. Caso seja necessário atualizar o item do notebook, selecione Notebook e escolha o novo notebook que será executado quando o webhook for ativado.
   7. Opcionalmente, adicione uma sequência alfanumérica que atue como um segredo para o webhook ou atualize um segredo pré-existente 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.
6. Clique em Atualizar webhook para aplicar as alterações.

Atualizar webhooks de serviço

Para atualizar as propriedades de um webhook de serviço, siga estas etapas:

1. Verifique se você está conectado 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.

2. Navegue até Organização > Configurações > Webhooks.
3. Em Webhooks de Serviço, localize o webhook que deseja atualizar.
4. Clique no botão Opções e clique em Editar.
5. Na janela Editar webhook, modifique o seguinte:
   1. Para atualizar o nome do webhook, forneça um nome exclusivo para o webhook na caixa de texto Nome.
   2. Para atualizar o serviço ao qual o webhook está associado, clique no menu suspenso Serviço e selecione um novo 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.

   3. Se você selecionar um webhook de serviço da feição, selecione novos ativadores de eventos no menu suspenso Eventos. Por exemplo, se você desejar que o webhook seja invocado quando um anexo de feição for atualizado, selecione AttachmentsUpdated.
   4. Caso seja necessário atualizar a URL de carga útil, selecione URL do Webhook e forneça a nova URL de carga útil para o receptor de webhook.
   5. Opcionalmente, adicione uma sequência alfanumérica que atue como um segredo para o webhook ou atualize um segredo pré-existente 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.
6. Clique em Atualizar webhook para aplicar as alterações.

Desativar webhooks

Os webhooks podem ser desativados manualmente ou quando a política de desativação for 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 webhooks de organização e serviço.

Desativar webhooks da organização

Para desativar um webhook da organização por meio do site de portal do ArcGIS Enterprise, siga estas etapas:

1. Verifique se você está conectado como administrador padrão ou membro de um papel personalizado com privilégios administrativos para criar e gerenciar webhooks da organização.
2. Navegue até Organização > Configurações > Webhooks.
3. Em Webhooks da organização, localize o webhook da organização que deseja desativar e clique em Ativo.
4. Clique em Confirmar para pausar o webhook.

Desativar webhooks de serviço

Para desativar um webhook de serviço, faça o seguinte:

1. Verifique se você está conectado 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.

2. Navegue até Organização > Configurações > Webhooks.
3. Em Webhooks de serviço, localize o webhook de serviço que deseja desativar e clique em Ativo.
4. Clique em Confirmar para pausar o webhook.

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 de organização e serviço desativados anteriormente.

Ativar webhooks da organização

Para ativar um webhook da organização por meio do site de portal ArcGIS Enterprise, siga estas etapas:

1. Verifique se você está conectado como administrador padrão ou membro de um papel personalizado com privilégios administrativos para criar e gerenciar webhooks da organização.
2. Navegue até Organização > Configurações > Webhooks.
3. Em Webhooks da organização, localize o webhook da organização que deseja ativar e clique em Inativo.
4. Clique em Confirmar para reiniciar o webhook.

Ativar webhooks de serviço

Para ativar um webhook de serviço, faça o seguinte:

1. Verifique se você está conectado 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.

2. Navegue até Organização > Configurações > Webhooks.
3. Em Webhooks de serviço, localize o webhook de serviço que deseja ativar e clique em Inativo.
4. Clique em Confirmar para reiniciar o webhook.

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 de organização e serviço.

Excluir webhooks da organização

Para atualizar um webhook da organização por meio do site de portal do ArcGIS Enterprise, siga estas etapas:

1. Verifique se você está conectado como administrador padrão ou membro de um papel personalizado com privilégios administrativos para criar e gerenciar webhooks da organização.
2. Navegue até Organização > Configurações > Webhooks.
3. Em Webhooks da organização, localize o webhooks da organização que você deseja atualizar.
4. Clique no botão Opções e clique em Excluir.
5. Na janela Excluir, clique no botão Confirmar para remover permanentemente o webhook.

Excluir webhooks de serviço

Para excluir um webhook de serviço, faça o seguinte:

1. Verifique se você está conectado 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.

2. Navegue até Organização > Configurações > Webhooks.
3. Em Webhooks de serviço, localize o webhook de serviço que deseja atualizar.
4. Clique no botão Opções e clique em Excluir.
5. Na janela Excluir, clique no botão Confirmar para remover permanentemente o webhook.