Crear webhooks

Como administrador de una organización, puede configurar webhooks para que se notifiquen en su implementación de ArcGIS Enterprise cuando se produzcan eventos específicos. En las siguientes secciones se describe cómo configurar los webhooks de servicios y de organización.

Requisitos previos a crear webhooks

Considere lo siguiente antes de crear webhooks:

• Para utilizar webhooks de organización, su organización debe utilizar ArcGIS Enterprise 10.7 o versiones posteriores. Para utilizar webhooks de servicios, su organización debe utilizar ArcGIS Enterprise 11.0 o versiones posteriores.
• Para crear y administrar webhooks de organización, debe tener asignado el privilegio Webhooks de organización o tener asignado el rol de administrador predeterminado.
• Para crear y administrar webhooks de servicios de geoprocesamiento, debe tener asignado el privilegio Geoprocesamiento, el rol de administrador predeterminado o el rol de publicador.
• Para crear y administrar webhooks de servicios de entidades, debe tener asignado el privilegio Capa de entidades, el rol de administrador predeterminado o el rol de publicador.
• Los receptores de webhook se deben configurar para que se comuniquen a través de HTTPS. Existen algunas opciones que son compatibles con los receptores, como receptores de servicios web de terceros (Microsoft Power Automate, Zapier e IFFT) y servicios web personalizados. Para obtener ejemplos de cómo crear servicios web personalizados o empezar a utilizar receptores de terceros, consulte el repositorio de webhooks.
• Para configurar webhooks para un servicio de entidades alojadas, el servicio debe incluir la funcionalidad de edición y tener habilitado el rastreo de cambios sin sincronización.
• Para configurar webhooks para un servicio de entidades no alojadas, los datos de la geodatabase corporativa a los que hace referencia el servicio deben cumplir los requisitos del seguimiento de cambios y seguir uno de estos patrones:
  • Es un servicio de entidades no versionadas con el archivado habilitado e Id. globales.
  • Es un servicio de entidades versionado en rama sin la capacidad de Administración de versiones habilitada en el que las ediciones se aplican de manera directa a las entidades de la versión predeterminada.
  • Es un servicio de entidades versionado en rama con la capacidad de Administración de versiones habilitada. Cuando la capacidad de Administración de versiones está habilitada, el servicio puede crear un webhook que tenga el desencadenador de eventos FeaturesPosted, que invoca el webhook cada vez que se lleva a cabo la operación posterior en el servicio.

  Nota:

  En ArcGIS Enterprise 11.3 se ha agregado la compatibilidad con los servicios de entidades versionados en rama.

• Para configurar webhooks para un servicio de geoprocesamiento, el servicio debe ser asíncrono.

Configurar webhooks de la organización

Los webhooks de organización le permiten suscribirse a desencadenadores de eventos asociados con sus elementos, grupos y usuarios del portal de ArcGIS Enterprise.

Crear un webhook de organización

Para crear un webhook de organización a través del sitio web del portal de ArcGIS Enterprise, siga estos pasos:

1. Compruebe que haya iniciado sesión como administrador predeterminado o como miembro de un rol personalizado con el privilegio Webhooks de organización.
2. Vaya a Organización > Configuración > Webhooks.
3. En Webhooks de organización, haga clic en Crear webhook.
4. En la ventana Crear webhook, haga lo siguiente:
   1. Proporcione un nombre único para el webhook en el cuadro de texto Nombre.
   2. Seleccione un tipo de webhook en el menú desplegable Tipo.
      • Al seleccionar Todo, se le suscribe a todos los desencadenadores de eventos compatibles. Recibirá notificaciones de cada evento a medida que ocurran.
      • Seleccionar Elementos, Usuarios, Grupos o Roles le permite definir manualmente a qué desencadenadores de eventos desea suscribirse.
   3. Si selecciona un tipo de webhook distinto de Todo, aparecerá un menú desplegable adicional relativo al tipo de webhook elegido. Por ejemplo, si seleccionó Elementos para el tipo de webhook, aparece el menú desplegable Elementos, que le permite seleccionar un elemento específico que supervisará el webhook.
   4. Seleccione los desencadenadores de eventos en el menú desplegable Eventos. Por ejemplo, si desea que se invoque el webhook al publicar un elemento específico, seleccione /items/<item ID>/publish.
   5. Proporcione la URL de carga del receptor de webhook en el cuadro de texto URL de webhook. A continuación, se muestra un ejemplo de URL de carga:
      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
      

   6. Opcionalmente, defina un valor secreto para el webhook en el cuadro de texto Secreto (opcional). El valor del secreto se utilizará para generar una firma que se incluirá en los encabezados de la carga del webhook. El receptor del webhook puede utilizar esta firma para determinar si el mensaje es de confianza.
5. Haga clic en Crear webhook.

Configurar parámetros avanzados para webhooks de organización

La configuración avanzada aplicada a los webhooks de su organización le permite personalizar aún más el rendimiento de los webhooks, por ejemplo, especificando el número de intentos de entrega, el tiempo de notificación y el tiempo entre intentos de entrega.

Para establecer propiedades avanzadas a través del sitio web del portal de ArcGIS Enterprise, haga lo siguiente:

1. Inicie sesión en su organización como administrador predeterminado o como miembro de un rol personalizado con el privilegio Webhooks de organización.
2. Vaya a Organización > Configuración > Webhooks.
3. En Webhooks de organización, haga clic en Configuración de webhooks avanzada.
4. En la ventana Configuración de webhooks avanzada, haga lo siguiente:
   1. Defina un valor para Número de intentos de envío.

      Este valor especifica el número de intentos que se realizarán para enviar las cargas de webhooks. De forma predeterminada, el portal de ArcGIS Enterprise intentará enviar cargas 3 veces. El valor de intentos debe ser un entero entre 0 y 5.

   2. Defina un valor para Tiempo de espera de notificación.

      Este valor especifica el periodo de tiempo, en segundos, que esperará el portal de ArcGIS Enterprise para recibir una respuesta de un receptor. De forma predeterminada, el portal de ArcGIS Enterprise esperará 10 segundos. El valor del número de segundos que el portal de ArcGIS Enterprise esperará debe ser un entero entre 0 y 60 segundos.

   3. Defina un valor para Tiempo de notificación transcurrido.

      Este valor especifica la cantidad de tiempo, en segundos, entre cada intento de envío de carga. De forma predeterminada, el portal de ArcGIS Enterprise intentará enviar otra carga después de 5 segundos si se produce un error en el intento anterior hasta que se haya alcanzado el número de intentos especificado en Número de intentos de envío.

5. Una vez configurados los ajustes anteriores, haga clic en Guardar.

   Las propiedades actualizadas se aplicarán a todos los webhooks de la organización configurados.

Configurar webhooks de servicio

Los webhooks de servicio le permiten suscribirse a desencadenadores de eventos asociados a los servicios de entidades de su organización o cuando se completan los trabajos del servicio de geoprocesamiento.

Crear un webhook de servicios

Para crear un webhook para un servicio de geoprocesamiento o para un servicio de entidades, siga estos pasos:

1. Inicie sesión en su organización como administrador predeterminado o como miembro con un rol personalizado con privilegios administrativos para crear y administrar los webhooks de servicio.

   Nota:

   Los miembros que tengan asignado el rol Publisher podrán crear o administrar webhooks de servicio desde el sitio del portal de ArcGIS Enterprise y tendrán que llevar a cabo estos flujos de trabajo mediante la API administrativa.

2. Vaya a Organización > Configuración > Webhooks.
3. En Webhooks de servicio, haga clic en Crear webhook.
4. En la ventana Crear webhook, haga lo siguiente:
   1. Proporcione un nombre único para el webhook en el cuadro de texto Nombre.
   2. Seleccione un servicio en el menú desplegable Servicio.

      Nota:

      Al seleccionar un servicio de geoprocesamiento el evento se establecerá como Servicio finalizado. Al seleccionar un servicio de entidades se hablitará el menú desplegable Eventos.

   3. Si selecciona un webhook de servicio de entidades, seleccione un desencadenador de evento en el menú desplegable Eventos. Por ejemplo, si desea que el webhook se invoque cuando una edición incluya un nuevo archivo adjunto, seleccione AttachmentsCreated.
   4. Proporcione la URL de carga del receptor de webhook en el cuadro de texto URL de webhook. A continuación, se muestra un ejemplo de URL de carga:
      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. Opcionalmente, defina un valor secreto para el webhook en el cuadro de texto Secreto (opcional). El valor del secreto se utilizará para generar una firma que se incluirá en los encabezados de la carga del webhook. El receptor del webhook puede utilizar esta firma para determinar si el mensaje es de confianza.
5. Haga clic en Crear webhook.

Configurar parámetros avanzados para webhooks de servicio

La configuración avanzada aplicada a los webhooks de servicio le permite personalizar aún más el rendimiento de los webhooks, por ejemplo, especificando el número de intentos de entrega, el tiempo de notificación y el tiempo entre intentos de entrega.

Para establecer propiedades avanzadas a través del sitio web del portal de ArcGIS Enterprise, haga lo siguiente:

1. Inicie sesión en su organización como administrador predeterminado o como miembro con un rol personalizado con privilegios administrativos para crear y administrar los webhooks de servicio.

   Nota:

   Los miembros que tengan asignado el rol Publisher podrán crear o administrar webhooks de servicio desde el sitio del portal de ArcGIS Enterprise y tendrán que llevar a cabo estos flujos de trabajo mediante la API administrativa.

2. Vaya a Organización > Configuración > Webhooks.
3. En Webhooks de servicio, haga clic en Configuración de webhooks avanzada.
4. En la ventana Configuración de webhooks avanzada, haga lo siguiente:
   1. Defina un valor para Número de intentos de envío.

      Este valor especifica el número de intentos que se realizarán para enviar las cargas de webhooks. De forma predeterminada, el sistema intentará enviar cargas 3 veces. El valor de intentos debe ser un entero entre 0 y 5.

   2. Defina un valor para Tiempo de espera de notificación.

      Este valor especifica el periodo de tiempo, en segundos, que esperará el sistema para recibir una respuesta de un receptor. De forma predeterminada, el sistema esperará 10 segundos. El valor debe ser un entero entre 0 y 60 segundos.

   3. Defina un valor para Tiempo de notificación transcurrido.

      Este valor especifica la cantidad de tiempo, en segundos, entre cada intento de envío de carga. De forma predeterminada, el sistema intentará enviar otra carga después de 5 segundos si se produce un error en el intento anterior hasta que se haya alcanzado el número de intentos especificado en Número de intentos de envío.

   4. Establezca un valor para Número de días transcurridos.

      Este valor especifica el número de días durante los que puede producirse un número determinado de fallos antes de que se desactive el webhook. De forma predeterminada, el sistema aceptará un número determinado de fallos (especificado en Número máximo de fallos) en el transcurso de 5 días. El valor debe ser un número entero entre 1 y 30.

   5. Establezca un valor para Número máximo de fallos.

      Este valor especifica el número de fallos que pueden ocurrir durante un número específico de días antes de que el webhook se desactive. De forma predeterminada, el sistema aceptará 5 fallos durante un número determinado de días (especificado en Número de días transcurridos) antes de que se desactiven los webhooks. El valor debe ser un número entero entre 1 y 30.

5. Una vez configurados los ajustes anteriores, haga clic en Guardar.

   Las propiedades actualizadas se aplicarán a todos los webhooks de servicio configurados.