Acción de API de Webhook / REST


Descripción general

La acción de Webhook / REST API sirve como un medio para interactuar y realizar eventos en cualquier aplicación de terceros a través de la URL configurada. Cualquier alerta generada por el Administrador de aplicaciones activará las acciones de la API de Webhook / REST para enviar los detalles requeridos del evento y le permite optimizar y administrar sus alarmas críticas, incidentes o mensajes en cualquier aplicación de terceros.

Creación de una nueva acción de API de Webhook / REST

Para crear una nueva acción Webhook / RestAPI, siga los pasos que se indican a continuación:

  1. Seleccione la  opción Acción RestAPI del  menú Acciones .
  2. Ingrese el  Nombre para mostrar de la acción.
  3. Ingrese la  (s) URL (s) HTTP para las que se debe activar la acción de la API REST.
  4. Elija el  Método de envío de formulario utilizando cualquiera de los siguientes métodos HTTP:  GET, POST, PUT, DELETE  o  PATCH .
  5. Elija el  tipo PayLoad para enviar solicitudes de datos a través de  FORM, texto, XML  o JSON .
  6. Ingrese los  parámetros personalizados  que se enviarán en los  cuadros de texto ClaveValor según corresponda. Puede agregar / eliminar múltiples parámetros personalizados usando los  botones (+ / -) .Acción de API de Webhook / REST: parámetros personalizados
  7. Ingrese los  encabezados de solicitud  ( solicitudes de encabezado HTTP) que deben enviarse para solicitar páginas / datos específicos de la URL HTTP. Puede agregar / eliminar múltiples parámetros de solicitud de encabezado usando los  botones (+ / -) .
  8. Ingrese los  detalles del agente de usuario del software solicitante desde el cual se envían las solicitudes HTTP. Puede elegir los detalles requeridos de la cadena de Usuario-Agente de la lista que se muestra mientras ingresa el valor en el cuadro de texto.
  9. Elija el  método de autenticación requerido, si corresponde, eligiendo cualquiera de los siguientes métodos de autenticación:
    • Sin autenticación: esta opción le permite acceder a la URL HTTP sin ninguna autenticación.
    • Básico / NTLM: esta opción le permite acceder a la URL HTTP con un método de autenticación básico (Protocolo NTLM). Esto se puede configurar ingresando el nombre de usuario y la contraseña requeridos para acceder a la URL.
    • OAuth: esta opción le permite acceder a la URL HTTP mediante OAuth (autorización abierta). Esto se puede configurar seleccionando el proveedor OAuth requerido para acceder a la URL, en la lista desplegable. Además, puede crear un nuevo proveedor de OAuth haciendo clic en el  enlace Agregar proveedor de OAuth . (Referir  al proveedor de Oauth )

    Acción de API de Webhook / REST: autenticación

    Acción de API de Webhook / REST - OAuth

  10. Puede usar la   opción Notificar después de la ejecución de la acción para las condiciones de éxito o falla de una acción, ya sea seleccionando una dirección de correo electrónico existente o definiendo una nueva dirección de correo electrónico mediante el  enlace Nueva acción . En condiciones de éxito, puede optar por recibir una respuesta correcta de la API a través del correo utilizando cualquiera de las siguientes opciones:
    • Enlace:  esta opción envía la respuesta URL como un enlace web a su correo.
    • Inline:  esta opción envía la respuesta URL cargándola dentro del propio correo.

    Nota : Si se elige la opción Inline y la respuesta de la API excede el límite de tamaño del correo, la respuesta se enviará como un enlace web. El valor límite de tamaño del correo se puede especificar en la pestaña Administrador -> Configuración del producto -> Configuración global .

  11. Ingrese el   valor de Tiempo de espera dentro del cual se debe establecer una conexión con la URL.
  12. Haga clic en el  botón Crear acción para terminar de crear la acción de la API de descanso.Acción API de Webhook / REST: notificaciones por correo

Después de crear la acción de la API Webhook / Rest, puede probar su ejecución haciendo clic en el  icono Ejecutar de esa acción.

Integraciones de webhook

Consulte los siguientes enlaces para aprender cómo integrar los productos respectivos usando Webhook: