Descripción general de las notificaciones#
Apidog le permite integrarse con aplicaciones de terceros para enviar notificaciones a destinatarios designados cuando ocurren determinados eventos. Cuando se activa un evento específico, las notificaciones se envían en tiempo real a plataformas como Slack. Los canales de notificación compatibles actualmente incluyen:Solo los administradores del proyecto pueden configurar los ajustes de notificación. Actualmente, las notificaciones por correo electrónico solo están disponibles para los siguientes eventos:Prueba automatizada completada/fallida
Integración continua completada/fallida
Tareas programadas completadas/fallidas
Destinatarios de notificación#
Los destinatarios de notificación son los receptores que reciben mensajes a través de un canal específico cuando ocurren determinados eventos.Para configurar notificaciones, primero debe crear un destinatario de notificación especificando un nombre, seleccionando un canal y configurando sus ajustes. Cada canal tiene un proceso de configuración único. Las secciones siguientes le guiarán paso a paso para configurarlos.Slack#
Apidog admite el envío de eventos de notificación a un canal específico en Slack mediante la integración de aplicaciones de Slack: Incoming WebHooks en el canal especificado y la configuración de la URL de Webhook de Incoming WebHooks, que puede enviar mensajes de eventos al canal de Slack.Descripción de los campos de configuración:| Campo de configuración | Obligatorio | Descripción |
|---|
| Nombre de la notificación | No | Asigne un nombre a la notificación integrada de terceros para registrar su propósito. |
| Eventos desencadenantes | Sí | Eventos compatibles: cambios de API, cambios de esquema, cambios de documento, importación de datos, pruebas de automatización |
| URL del servicio | Sí | URL de Webhook en "Incoming WebHooks - Integration Settings" |
Integrar la notificación de Apidog con Slack#
Los administradores del proyecto pueden utilizar funciones de integración de terceros para asociar las aplicaciones de Slack: Incoming WebHooks añadidas en Slack - Canales, con eventos de notificación del proyecto en Apidog para enviar cambios de API relacionados, cambios de documentación, finalizaciones de pruebas, etc., al canal especificado en Slack.Paso 1: Abra los detalles del canal
En el canal de Slack, haga clic en la opción "Open channel details" en la esquina superior derecha.Paso 2: Instale Incoming WebHook
En Integrations - Apps del canal específico, instale y añada Incoming WebHook.Paso 3: Vea Incoming WebHooks
Una vez completada la instalación, haga clic en el botón situado a la derecha de Incoming WebHooks - View.Paso 4: Configure Incoming WebHooks
Esto abrirá la página de descripción de Incoming WebHooks; haga clic en Configuration para configurarlo.Paso 5: Añada a Slack
Haga clic en Add to Slack.Paso 6: Seleccione el canal y añada la integración
Seleccione el canal al que desea enviar los mensajes de eventos de notificación de Apidog y haga clic en Add Incoming WebHooks integration.Paso 7: Obtenga la URL de Webhook
Obtenga y copie la URL de Webhook.Paso 8: Cree el destinatario de notificación en Apidog
Haga clic en "Settings" > "Notifications" > "Notification Targets" > y cree un nuevo destinatario de notificación.Rellene el nombre del destinatario de notificación.
Elija Slack como canal de notificación.
Pegue la URL de Webhook obtenida desde los ajustes de Incoming WebHooks en Service URL.
Teams#
La compatibilidad con el envío de notificaciones a Microsoft Teams permite que Workflows en Teams utilice estos mensajes como desencadenantes para acciones posteriores, como publicar mensajes automáticamente en un grupo o canal, lo que ayuda a los equipos a mantenerse informados sobre eventos importantes de Apidog.Específicamente, puede configurar un desencadenante de Webhook dentro de un Workflow. Cuando se activan determinados eventos de notificación en Apidog (por ejemplo, cambios de API, actualizaciones de documentación o finalizaciones de pruebas automatizadas), Apidog enviará una petición POST a la URL HTTP POST especificada del desencadenante, llevando la carga útil del evento.| Campo | Obligatorio | Descripción |
|---|
| Nombre | Sí | Un nombre que describa el propósito de este destinatario de notificación |
| URL HTTP POST | Sí | La URL donde el desencadenante de Webhook en el Workflow recibe peticiones POST |
Integrar la notificación de Apidog con canales de Teams#
Paso 1: Cree un flujo de trabajo en Teams
En Microsoft Teams → Workflow, haga clic en Create y puede comenzar rápidamente seleccionando la plantilla Post to a channel when a webhook request is received.Paso 2: Configure el nombre del flujo y la cuenta
Configure un nombre para el flujo, seleccione la cuenta adecuada y haga clic en Next.Paso 3: Elija el grupo y el canal
Elija el grupo y el canal donde desea recibir la notificación y, a continuación, haga clic en Create flow.Paso 4: Obtenga la URL HTTP POST
Una vez creado el flujo, se mostrará la URL HTTP POST bajo el paso del desencadenante. Puede copiarla directamente o encontrarla más tarde dentro del paso del desencadenante del flujo.Paso 5: Configure el destinatario de notificación en Apidog
Pegue esta URL HTTP POST en la configuración del destinatario de notificación en Apidog.Paso 6: Cree el evento de notificación
Cree un evento de notificación en Apidog y asócielo con el destinatario de notificación de Teams configurado.Paso 7: Verifique la notificación de Teams
Cuando se active este evento de notificación, el flujo de trabajo creado previamente publicará automáticamente un mensaje en el canal de Teams seleccionado.Webhook#
Admite el envío de eventos de notificación al servidor HTTP. Puede enviar mensajes de eventos al servidor HTTP especificando una dirección URL para recibir peticiones POST.Descripción de los campos de configuración:| Campo de configuración | Obligatorio | Descripción |
|---|
| Nombre de la notificación | No | Asigne un nombre a la notificación integrada de terceros para registrar el propósito de la notificación. |
| Evento desencadenante | Sí | Eventos compatibles: cambios de API, cambios de modelo de datos, cambios de documento, importación de datos, pruebas de automatización |
| URL del servidor | Sí | Dirección URL del servidor HTTP para recibir peticiones |
| Autenticación de firma | No | El contenido enviado se cifra mediante el algoritmo de cifrado HMAC SHA1, utilizando un token como KEY para mostrar el valor en hexadecimal (requiere un token configurado), y contiene el prefijo sha1= |
Integrar la notificación de Apidog con un servidor HTTP autoalojado#
Los administradores del proyecto pueden utilizar la integración de terceros para asociar su servidor HTTP autoalojado con los eventos de notificación del proyecto en Apidog, con el fin de recibir notificaciones de cambios de API relevantes, cambios de documento y finalizaciones de pruebas de automatización en su servidor HTTP.Para integrar la notificación de Apidog con un servidor HTTP autoalojado, haga clic en "Settings" > "Notifications" > "Notification Targets" > y cree un nuevo destinatario de notificación.1.
Rellene el nombre del destinatario de notificación.
2.
Elija Webhook como canal.
3.
Pegue la URL del servidor HTTP autoalojado en el campo Service URL.
4.
Si la verificación de firma está habilitada, copie y pegue la clave en el campo Signature Key.
Jenkins#
Admite el envío de eventos de notificación al servicio Jenkins. Al configurar la URL de Webhook de Jenkins, los mensajes de eventos pueden enviarse a Jenkins.Descripciones de los campos de configuración:| Campo de configuración | Obligatorio | Descripción |
|---|
| Nombre de la notificación | No | Asigne un nombre a la notificación de integración de terceros para registrar su propósito. |
| Eventos desencadenantes | Sí | Cambios de API, cambios de modelo de datos, importación de datos, pruebas de automatización. Las notificaciones en tiempo real se activarán cuando ocurra cualquiera de los eventos anteriores. |
| URL del servicio | Sí | La URL se configura en el plugin Generic Webhook Trigger. |
| Autenticación de firma | No | Se envía al plugin Generic Webhook Trigger mediante el encabezado Authorization Bearer. |
Integrar la notificación de Apidog con el servicio Jenkins#
Los administradores del proyecto pueden utilizar la funcionalidad de integración de terceros para asociar la URL de Webhook configurada en el plugin Generic Webhook Trigger de Jenkins con eventos de notificación del proyecto en Apidog, para activar automáticamente una acción de compilación en Jenkins cuando se activen eventos como cambios de API, cambios de documento y finalizaciones de pruebas de automatización, y ver mensajes en el historial de compilación.Paso 1: URL de Webhook configurada en el plugin Jenkins Generic Webhook Trigger
Cree una nueva vista en el panel de Jenkins:Haga clic en la vista del paso anterior para entrar en Configure>Build Triggers y seleccione Generic Webhook Trigger. La URL de Webhook es "http://"+"your service address"+"/generic-webhook-trigger/invoke"Se admite el token personalizado:Paso 2: Cree un nuevo destinatario de notificación
Haga clic en "Settings" > "Notifications" > "Notification Targets" > y cree un nuevo destinatario de notificación.Rellene el nombre del destinatario de notificación.
Si se utiliza un token personalizado, copie y pegue el Token en el campo Signature Token.
Email#
Las notificaciones pueden enviarse por correo electrónico a direcciones de correo electrónico especificadas. Actualmente, las notificaciones por correo electrónico solo están disponibles para los siguientes eventos:Prueba automatizada completada/fallida
Integración continua completada/fallida
Tareas programadas completadas/fallidas
| Campo | Obligatorio | Detalles |
|---|
| Nombre | Sí | Un nombre descriptivo que resalte el propósito o las características del destinatario de notificación. |
| Dirección de correo electrónico de notificación | Sí | Introduzca la(s) dirección(es) de correo electrónico para recibir notificaciones. Puede seleccionar direcciones de correo electrónico de miembros del proyecto o escribir manualmente una dirección. Se admiten varias direcciones de correo electrónico. |
Integrar la notificación de Apidog con Email#
1.
Rellene el nombre del destinatario de notificación.
3.
Introduzca los correos electrónicos
Eventos de notificación#
Puede crear eventos de notificación para especificar qué eventos activarán notificaciones a destinatarios designados (destinatarios de notificación). Para configurar un evento de notificación, debe configurar:Nombre del evento de notificación
Destinatarios de notificación
Evento desencadenante#
Puede elegir entre los siguientes eventos de notificación para activar la notificación:| Evento desencadenante | Detalles |
|---|
| Endpoint cambiado | Endpoint creado
Endpoint actualizado
Endpoint eliminado |
| Esquema cambiado | Esquema creado
Esquema actualizado
Esquema eliminado |
| Documento cambiado | Documento creado
Documento actualizado
Documento eliminado |
| Importación de datos | Importación (importación manual)
Importación (sincronización automática) |
| Componente de respuesta cambiado | Componente de respuesta creado
Componente de respuesta actualizado
Componente de respuesta eliminado |
| Rama de sprint cambiada | Rama de sprint fusionada
Rama de sprint creada
Rama de sprint archivada
Rama de sprint eliminada
Rama de sprint recuperada |
| Versión de API cambiada | Versión de API creada
Versión de API eliminada |
| Esquema de seguridad cambiado | Esquema de seguridad creado
Esquema de seguridad actualizado
Esquema de seguridad eliminado |
Para notificaciones relacionadas con pruebas automatizadas (por ejemplo, prueba automatizada completada, integración continua completada, tarea programada completada), debe configurar los ajustes individualmente para cada escenario de prueba. Este enfoque es más flexible y se adapta mejor a los casos de uso reales.
Destinatarios de notificación#
Elija qué destinatarios de notificación recibirán la notificación cuando ocurra un evento desencadenante. Puede elegir entre los destinatarios de notificación que ya se hayan configurado en el proyecto y seleccionar varios destinatarios si es necesario.Sin embargo, las notificaciones por correo electrónico solo son compatibles con tres eventos específicos:Prueba automatizada completada/fallida
Integración continua completada/fallida
Tareas programadas completadas/fallidas
