Events

Events are a fundamental part of Catalyst Signals, describing any significant change or occurrence within an environment or application. They encircle a broad spectrum of actions and triggers ranging from user interactions to external stimuli. These events, in turn, serve as another trigger for innumerable actions or workflows across different environments or applications.

In Catalyst Signals, these events are pivotal in driving real-time processing, automation, and seamless integration of disparate systems and applications. With this tool, you can capture, process, and route these events to various endpoints called Targets.

Here are a couple of examples for an event:

• In an ecommerce marketing website, when a customer places an order, the inventory management application is automatically updated. In this scenario, the event is the Order Placement.
• In a CRM application, when a lead is created, the organization’s website displays product recommendations based on the lead’s details. In this scenario, lead creation serves as the event.

Event Statuses

To track the events within the Signals environment, they are categorized by their processing status. This represents the overall performance of an event, regardless of how many rules it is associated with or how many targets it is delivered to. The execution status of each rule and target can be found in the logs help page.

The overall event performance statuses in Signals are mentioned as follows:

• Received - Events received in Signals from all types of publishers.
• In Queue - Events received but not yet processed.
• In Progress - Events that are currently being processed.
• Success - For an event to be marked as a success, it must be delivered to every target, across all associated rules.
• Failed - Events that failed to be delivered to at least one target, in any of the associated rules, will carry an overall status as Failed.
• Unmatched - Events that did not meet the conditions configured in the rule filters or have no active rules or targets, and therefore were not processed.
• Unprocessed - Events that are inactive or associated with an inactive publisher, rule, or target.
• Dropped - Events associated with a deleted or disabled target or rule.

Zoho Events

The preconfigured services for Zoho publishers come equipped with default events, each accompanied by its own schema. This automated setup streamlines event management by eliminating the need for manual schema creation. Events from Zoho services are received into Signals through the internal authorization process of Catalyst with other services.Therefore, you need not perform any authorization configurations for Zoho publishers.

Events will be defined by default for custom modules created within Zoho CRM and Zoho Bigin services. Custom fields are also synchronized periodically to ensure trouble-free integration with event schemas during event transformation and webhook creation in Signals. The supported services for custom fields synchronization include:

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

Click here for the full list of supported Zoho Publishers

SaaS Events

The supported services in SaaS publishers also feature pre-populated events with corresponding schemas. However, to receive events in Signals, it is crucial to have the API token and organization ID provided during the publisher creation process. Without these two details, receiving events in Signals from the SaaS publisher is not possible.

Custom Events

To receive custom events in Signals, the REST API key for these events has to be configured within the custom publisher application. Additionally, a sample payload of the specific event is required to generate its schema.

Catalyst Signals offers two methods for adding event payloads to generate schemas:

• Live Event Payload: You can use the URL provided in this method to capture the payload of an API call and populate it with the necessary keys to use it as an event schema.

• Manual Event Payload: In this method, you need to manually provide the payload to generate the event schema.

Instructions for creating custom events and schemas for custom publishers

Event Schema

Event Schema contains the metadata of the events to provide additional context and information about the event. You can also edit the event schema and tailor it to your requirements to further trigger the workflows in the target environment. Learn how to extract or transform an event schema

Although this has been auto-generated by Catalyst Signals, let us analyze the default keys of an event schema to understand the processing of the events.

    

        
Sample Event Schema
        

            
copy
            

                

            
        
    
    

    

         
{
  "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"
      }
    }
  ]
}

         
View more
    

Default API Key in Schema