Catalyst

by Zoho
×
Cancel

ACCESS THIS PAGE
  • Tutorials
  • FAQ
  • Developer Tools
    CLI
    SDK
    Java Node.js Python Web Android iOS Flutter
    REST API
    Utilities
    Extensions Tools Integrations
    • Go to console

    Custom Publishers

    In addition to the existing default publishers, you can create new publishers with the product of your choice.

    For custom publishers, you must add your own events. To ensure these events are received in Signals, provide the REST API URL of the custom events in the publisher application where the events will be posted. The API URL supports up to 500 requests per minute. If this threshold is exceeded, the REST API will be locked for the next 60 seconds.

    Note:

    • The REST API URL generated for custom events in the development environment differs from the URL created for the same custom events in the production environment. Ensure you replace the URL when moving the project to production.

    • You can create and configure up to 25 Custom Publishers. This threshold is configured for baseline and standard scenarios only. We strongly urge you to email us at support@zohocatalyst.com with your requirement to increase this soft threshold.

    Creating a Custom Publisher

    To add a custom publisher:

    1. Navigate to Publishers on the left menu and click the Add Publisher button.

    Publishers Home Page

    1. Go to the Create Your Own Publisher section in the menubar and fill in the necessary details as shown here.

    Creating a Custom Publisher

    Enable Event Ordering to ensure events are delivered in the same order they were received and click Save.

    Refer to the Event Ordering help section to learn more.

    Enabling Event Order

    1. To add a custom event after providing the publisher details, click the Add Event button near the Events section.

    Adding an event to the Custom Publisher

    1. Fill in the details of Events and click Save.

      The values for the API Name field should not contain any white spaces or hyphens and must not exceed 50 characters. It accepts underscores and alphanumeric values but cannot start with a numerical value.

    Creating an event to the Custom Publisher

    Add Schema to Custom Events

    1. Click Add Schema of the custom event that you have created.

    Selecting the desired Custom Publisher

    1. A pop-up will appear with two methods to generate schema using the event payload.

    Generating Event Schema

    Manual

    You can manually add the schema to the custom events. Select the Manual option and provide the request payload of the event.

    The default keys of an event schema will be automatically populated on the right for the provided payload.

    Manual Event Schema Generation

    Live

    To capture an API call’s request payload and populate it here, select the Live Events option and copy the URL displayed here.

    Provide this URL in the Publisher from which the API call is made.

    Live Event Schema Generation

    In the GIF shown above, the live events URL is copied and provided to the publisher system. This URL listens to the publisher’s API calls for the next 15 minutes and displays them on this platform. You can select the required payload from the listened API calls and add its schema to the custom events.

    Note: The URL to capture the live events will last for only 15 minutes.
    1. Once you have generated the event schema, you can subscribe the event by associating it with a rule.

    Event Subscription

    Note:

    • For custom publishers, the maximum allowed size for events generated and emitted to Signals is 64 KB, with an array of events up to 256 KB, limited to a maximum of 25 events.

    • You need to ensure that the required PII configurations pertaining to the data stored in the Custom Publisher service needs to be restricted at the publisher service level. This would ensure continued compliance with industry standard data practices.

    Last Updated 2026-01-30 14:33:37 +0530 IST

    PREVIOUS

    NEXT