Events

Los Events son una parte fundamental de Catalyst Signals, ya que describen cualquier cambio u ocurrencia significativa dentro de un entorno o aplicación. Abarcan un amplio espectro de acciones y disparadores que van desde interacciones de usuarios hasta estímulos externos. Estos events, a su vez, sirven como otro disparador para innumerables acciones o flujos de trabajo en diferentes entornos o aplicaciones.

En Catalyst Signals, estos events son fundamentales para impulsar el procesamiento en tiempo real, la automatización y la integración fluida de sistemas y aplicaciones dispares. Con esta herramienta, puedes capturar, procesar y enrutar estos events a varios endpoints llamados Targets.

Aquí tienes un par de ejemplos de un event:

• En un sitio web de marketing de comercio electrónico, cuando un cliente realiza un pedido, la aplicación de gestión de inventario se actualiza automáticamente. En este escenario, el event es la realización del pedido.
• En una aplicación de CRM, cuando se crea un lead, el sitio web de la organización muestra recomendaciones de productos basadas en los detalles del lead. En este escenario, la creación del lead sirve como el event.

Event Statuses

Para rastrear los events dentro del entorno de Signals, se categorizan por su estado de procesamiento. Esto representa el rendimiento general de un event, independientemente de cuántas reglas tenga asociadas o a cuántos targets se entregue. El estado de ejecución de cada regla y target se puede encontrar en la página de ayuda de logs.

Los estados generales de rendimiento de events en Signals se mencionan a continuación:

• Received - Events recibidos en Signals desde todos los tipos de publishers.
• In Queue - Events recibidos pero aún no procesados.
• In Progress - Events que están siendo procesados actualmente.
• Success - Para que un event se marque como exitoso, debe ser entregado a cada target, en todas las reglas asociadas.
• Failed - Los events que no se pudieron entregar a al menos un target, en cualquiera de las reglas asociadas, tendrán un estado general de Failed.
• Unmatched - Events que no cumplieron las condiciones configuradas en los filtros de la regla o que no tienen reglas o targets activos, y por lo tanto no fueron procesados.
• Unprocessed - Events que están asociados con un publisher, regla o target inactivo.
• Dropped - Events asociados con un target o regla eliminado o deshabilitado.

Zoho Events

Los servicios preconfigurados para Zoho publishers vienen equipados con events predeterminados, cada uno acompañado de su propio schema. Esta configuración automatizada optimiza la gestión de events al eliminar la necesidad de crear schemas manualmente. Los events de servicios de Zoho se reciben en Signals a través del proceso de autorización interna de Catalyst con otros servicios. Por lo tanto, no necesitas realizar ninguna configuración de autorización para los Zoho publishers.

Los events se definirán por defecto para módulos personalizados creados dentro de Zoho CRM. Los campos personalizados también se sincronizan periódicamente para garantizar una integración sin problemas con los schemas de events durante la transformación de events y la creación de webhooks en Signals. Los servicios compatibles para la sincronización de campos personalizados incluyen:

• Zoho Bigin
• Zoho Billing
• Zoho Books
• Zoho CRM
• Zoho Expense
• Zoho Inventory
• Zoho Invoice

Haz clic aquí para ver la lista completa de Zoho Publishers compatibles

Catalyst Events

Algunos servicios de Catalyst también son compatibles como Catalyst Publishers predeterminados en Signals. Cada servicio de Catalyst viene con su propio conjunto de events predefinidos y schemas correspondientes. Estos events se listan automáticamente cuando el servicio se agrega como publisher, eliminando la necesidad de configuración manual.

Esto te permite capturar de forma fluida cambios a nivel de infraestructura como actualizaciones de datos, modificaciones de caché, acciones de archivos o actividades de autenticación, y enrutarlos a través de Signals para monitoreo, análisis o integración con procesos posteriores.

Custom Events

Para recibir custom events en Signals, la clave de REST API para estos events debe configurarse dentro de la aplicación del custom publisher. Además, se requiere un sample payload del event específico para generar su schema.

Catalyst Signals ofrece dos métodos para agregar payloads de events y generar schemas:

• Live Event Payload: Puedes usar la URL proporcionada en este método para capturar el payload de una llamada API y completarlo con las claves necesarias para usarlo como un event schema.

• Manual Event Payload: En este método, necesitas proporcionar manualmente el payload para generar el event schema.

Instrucciones para crear custom events y schemas para custom publishers

Event Schema

El Event Schema contiene los metadatos de los events para proporcionar contexto e información adicional sobre el event. También puedes editar el event schema y adaptarlo a tus requerimientos para activar aún más los flujos de trabajo en el entorno del target. Aprende cómo extraer o transformar un event schema

Aunque esto ha sido generado automáticamente por Catalyst Signals, analicemos las claves predeterminadas de un event schema para comprender el procesamiento de los events.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema#",
  "type": "object",
  "properties": {
      "rule_id": {
          "type": "string"
      },
      "target_id": {
          "type": "string"
      },
      "version": {
          "type": "integer"
      },
      "attempt": {
          "type": "integer"
      },
      "account": {
          "type": "object",
          "properties": {
              "org_id": {
                  "type": "string"
              },
              "project": {
                  "type": "object",
                  "properties": {
                      "environment": {
                          "type": "string"
                      },
                      "name": {
                          "type": "string"
                      },
                      "id": {
                          "type": "string"
                      }
                  }
              }
          }
      },
      "events": {
          "type": "array",
          "items": {
              "type": "object",
              "properties": {
                  "data": {
                      "type": "object"
                        
    },
                  "id": {
                      "type": "string"
                  },
                  "time_in_ms": {
                      "type": "string"
                  },
                  "source": {
                      "type": "string"
                  },
                  "event_config": {
                      "type": "object",
                      "properties": {
                          "api_name": {
                              "type": "string"
                          },
                          "id": {
                              "type": "string"
                          }
                      }
                  }
              }
          }
      }
  }
}

Aquí tienes un sample event payload generado basado en el schema para tu referencia.

{
  "rule_id": "123456789",
  "target_id": "98765432",
  "version": 1,
  "attempt": 1,
  "account": {
    "org_id": "87359421",
    "project": {
      "environment": "DEVELOPMENT",
      "name": "Project-Rainfall",
      "id": "12950000000020015"
    }
  },
  "events": [
    {
      "data": {
        
      },
      "id": "b05f449e-7eb0-4e7f-a40f-662820729d20",
      "time_in_ms": 1721312979144,
      "source": "publisher_id:12950000000021006/service:zohocrm/account:87394113",
      "event_config": {
        "api_name": "Lead Created",
        "id": "12950000000021007"
      }
    }
  ]
}

Claves API Predeterminadas en el Schema