Webhooks

Webhooks

Los webhooks facilitan las notificaciones automatizadas de HTTP a aplicaciones de terceros desde Zoho Projects. Con los webhooks, puede configurar sus propias URL HTTP y asociarlas a reglas empresariales específicas para automatizar todo el proceso de notificación relacionado con los temas. Para obtener más información sobre los webhooks, consulte WebHooks.org.

Configurar webhooks

  1. Vaya a > Rastreador de temas > webhooks.
  2. Haga clic en Agregar webhook.
  3. En la página Webhooks, especifique todos los parámetros necesarios.
  4. Haga clic en Guardar.

Lista de campos en la configuración de webhooks 

Nombre de campo
 Una descripción.
 Tipo de datos
 Restricción
Nombre

Especifique el nombre del webhook.

Texto

100 caracteres
URL que se notificará

Especifique la URL de la API REST de la aplicación de terceros.

 Dirección URL
 1000 caracteres
Método

Seleccione el tipo de método de API: POST o GET. De forma predeterminada, el método POST está seleccionado.

 Botón de selección
 -
Agregar parámetros de tema
  • Agregue parámetros de dos maneras: mediante el formato estándar o el formato definido por el usuario (xml, json, etc.).
  • Especifique el nombre del parámetro. Y especifique el valor de parámetro correspondiente elegido en los campos de tema.
  • Estos parámetros son significativos en la activación del webhook a un tercero.
 Texto
 3000 caracteres
Agregar parámetros personalizados
  • Especifique el nombre del parámetro y el valor correspondiente para el webhook.
  • Este par clave-valor se utiliza principalmente para enviar tokens de autenticación, claves de API, etc.
 Texto
 3000 caracteres
URL de vista previa

Visualice previamente la URL del webhook completa que se notificará a la aplicación de terceros.

 Solo lectura
 Solo lectura

Asociar un webhook a una regla empresarial

  1. En Reglas empresariales, vaya a Detalles de la Regla > Criterios > Acciones.
  2. En Acciones, haga clic en Llamar webhooks.
  3. Haga clic en para crear un nuevo webhook o haga clic en a fin de llamar un webhook existente para la regla empresarial.

  4. Haga clic en Guardar regla.

Obtenga más información sobre la configuración de reglas empresariales.

Probar la integración de un webhook

  1. Agregue datos de prueba a Zoho Projects, de acuerdo con los criterios de la regla empresarial.
  2. En la aplicación, verifique la actualización o los datos recibidos de Zoho Projects a través de la notificación de webhook.
  3. Si hay un error o discrepancia de datos, modifique la configuración de webhooks en Zoho Projects.
  4. Continúe con las pruebas hasta que obtenga los resultados deseados de Zoho Projects a la aplicación.
Los webhooks admiten parámetros relacionados con temas (título del tema, estado, asignatario, etc.) y parámetros personalizados.

Limitaciones conocidas

  • Solo se permiten 10 parámetros relacionados con temas y 5 parámetros personalizados por webhook.
  • Se permite un parámetro relacionado con temas en formato definido por el usuario (xml, json, etc.).
    • Ejemplo de parámetro relacionado con temas en formato definido por el usuario: <issue-data><title>${Issue.IssueTitle}</title><key>${Issue.IssueKey}</key></issue-data>.
  • El webhook solo se activa mediante una regla empresarial; es decir, cuando se ejecuta una regla empresarial, se llama al webhook asociado.
  • Solo un webhook está asociado a una regla empresarial, mientras que varias reglas empresariales están asignadas al mismo webhook.
  • Solo se permiten 1000 llamadas de webhook por día.
  • No se reintenta una ejecución fallida del webhook.
  • El webhook se desactiva cuando la llamada del webhook falla 10 intentos de forma continua.
  • No se envía ninguna notificación por correo si se alcanza el umbral de llamada de webhooks para el día o si el webhook está deshabilitado debido a una falla continua.
  • Las fallas de webhook se auditan y la página Fallas de webhook muestra solo las últimas 100 fallas.


Códigos de error

Cuando hay una falla en la ejecución de un webhook, se mostrará uno de los siguientes mensajes de error en Zoho Projects: 

Códigos de estado de HTTP

  • Solicitud incorrecta (400): a menudo se debe a que falta un parámetro obligatorio.
  • No autorizado (401): falta un token de autenticación válido.
  • Error de solicitud (402): los parámetros eran válidos, pero la solicitud falló.
  • No encontrado (404): el elemento solicitado no se encontró.
  • Errores de servidor 500, 502, 503 y 504: hubo un error en la aplicación de terceros.
  • Código de error 1: en este momento no se puede establecer conexión con el servidor de la API. Debe verificar los registros del servidor de la API y la configuración del firewall para las solicitudes enviadas desde Zoho Projects.

Errores personalizados

  • Falla del proceso interno: cuando el webhook no se ejecuta debido a errores mientras se procesa el webhook.
  • Se alcanzó el límite diario: cuando la empresa alcanza el límite máximo del día.

Panorama empresarial

Enviar alertas de SMS a los propietarios del proyecto. 

Finalidad

Cuando un problema está marcado como Problema grave en el rastreador de temas, puede enviar un SMS con el título del tema al propietario del proyecto mediante la asociación de un webhook a una regla empresarial.

Requisito previo

  • Cuenta en el servicio de puerta de enlace de SMS
  • Permiso para acceder a las reglas empresariales y los webhooks

Procedimiento

  • Cree una cuenta en el servicio de puerta de enlace de SMS.
  • Configure el webhook en el rastreador de temas de Zoho.
  • Configure una regla empresarial.
  • Pruebe la integración del webhook.

 Paso 1: crear una cuenta en el portal de SMS

En el servicio de portal de SMS, cree una cuenta y obtenga los siguientes detalles para configurar el webhook:

  • Dirección URL de la API
  • Nombre de usuario
  • Contraseña
  • ID de la API 

Actualmente, Zoho se asoció con los siguientes proveedores de puerta de enlace de SMS:

  1. Bulk SMS
  2. Clickatell
  3. Screen Magic
  4. Valueleaf
  5. Solutions Infini

Puede comprar créditos de SMS y detalles de API de los proveedores mencionados.

 Paso 2 - Configurar webhook

En la página Webhooks, especifique los siguientes detalles:

URL que se notificará:

  1. http://<Dirección IP>/smsgateway/post: método POST. 

Parámetros en formato definido por el usuario:

Nombre del parámetro: texto.

Valor del parámetro:

                        Hola, ${Issue.ProjectOwner}:

                        El siguiente problema está marcado como ${Issue.Severity}.

                        ${Issue.IssueKey} - ${Issue.IssueTitle}

                        Vence el ${Issue.DueDate}.

Parámetro personalizado (nombre = valor):

                       usuario = <gateway_user_name>

                       contraseña = <api_password>

                       api_id = <gateway_unique_api_id>

                       a = <user_mobile_number>

En el parámetro definido por el usuario y personalizado anterior, hemos utilizado el portal de ClickaTell para fines de demostración.

 Paso 3: establecer una regla empresarial

Cree una regla empresarial con las siguientes especificaciones:

  1. Nombre de la regla empresarial: “Problema grave”. 
  2. Ejecutar en (actualización de campo) Gravedad.
  3. Criterios: la gravedad es “Problema grave” y el estado es “No cerrado”.
  4. Acción:
    • Reproducible: siempre.
    • Asignar a: desarrollador.
    • Llamar al webhook: seleccione el webhook creado en el paso anterior.
  5. Guarde la regla empresarial. Obtenga más información sobre cómo crear reglas empresariales.

 Paso 4: probar la integración

Agregue un tema de prueba en el proyecto y asígnelo a un desarrollador. Además, cambie el valor de Gravedad a Mostrar el problema grave. Esto activará el webhook asociado con la regla anterior y el propietario del proyecto recibirá una alerta de SMS con el título del tema, la gravedad y la fecha de vencimiento.


    • Related Articles

    • Webhooks para tareas

      Los webhooks facilitan las notificaciones automatizadas de HTTP a aplicaciones de terceros desde Zoho Projects. Los webhooks le permiten enviar datos en tiempo real de una aplicación a otra cada vez que se produce un evento. Con Webhooks, puede ...

    • Integración en Bitbucket

      Puede ser difícil hacer un seguimiento de múltiples líneas de código y versiones cambiantes. Confirme los códigos en Bitbucket y vea los conjuntos de cambios en Zoho Projects. Puede integrar Zoho BugTracker a Bitbucket utilizando webhooks. Debe ser ...

    • Integración de Gitea

      La integración de Gitea le permite alojar sus repositorios, ver commits de fuente y realizar cambios de código. Por lo tanto, ahora puede ver todos los cambios realizados en su repositorio de Gitea en Zoho Projects. Debe copiar la URL del webhook en ...

    • Integración en GitHub

      La integración de GitHub le permite alojar sus repositorios, ver commits de fuente y realizar cambios de código. Por lo tanto, ahora puede ver todos los cambios realizados en su repositorio de GitHub en Zoho Projects. Disponibilidad de funciones: ...

    • Asignar problemas a un equipo

      Zoho Projects le permite asignar equipos a los errores del proyecto. El campo Equipo asociado lo ayuda a reunir errores en su proyecto con sus equipos, para que pueda resolverlos de manera más efectiva. Beneficios Hacer un seguimiento de los ...