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.

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
  1. To add a custom event after providing the publisher details, click the Add button near the Events section.
Adding an event to the Custom Publisher
  1. Fill in the details of Events and click Create.

    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
  1. Once you have created your event, click the Save button in the top-right corner.
Saving the Custom Publisher

Add Schema to Custom Events

Subscribed Events of a Custom Publisher are those with which you have created a rule. Non-Subscribed Events are the default events that have not yet been associated with any rule.

  1. Select your desired custom publishers from the configured publishers list.
Selecting the desired Custom Publisher
  1. Click the more icon of a custom event from either Subscribed Events or Non-Subscribed Events. Select the Add Schema option.
Adding schema to a Custom Event
  1. A pop-up will appear with two methods to provide the event payload and generate schema.
Generating Event Schema

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.

Manual

You can also 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
  1. Click Save once you have generated the event schema.
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.

Last Updated 2025-04-11 18:35:15 +0530 +0530