Subscribing to Event Streams

To subscribe to an event stream, make sure you have a Cinchy Listener running connected to the Cinchy instance you are on. You will need to create a record in the Listener Configs table and Enable it to subscribe to events.

Column

Value

Event Connector Type

Choose the connector type

Topic

Refer to the topic JSON of the connector type you are configuring.

Connection Attributes

Refer to the connection attributes JSON of the connector type you are configuring.

Status

Make sure you set the value to Disabled when creating the config for the first time. This will give you a chance to correctly configure the listener before it is picked up by the service. After configuring the listener correctly you should flip the value to Enabled.

Data Sync Config

CLI Sync Configuration you want to use to sync records from your real time sync.

Subscription Expires On

This field is a timestamp that is populated by the Event Listener service when it has successfully subscribed to a topic.

Message

If there are any errors in the configuration, the Event Listener will disable the topic and write the error message here.

Auto Offset Reset

Earliest, Latest or None. This value is used when either there is no last message ID, or when the last message ID is invalid. Earliest will start reading from the beginning on the queue, latest will wait for the next message, and none will shut down that listener.

Testing an Event Stream

Once you have created your listener configuration, you can switch the status to Enabled. If there is a Cinchy Listener running pointing to this Cinchy Platform instance, it will attempt to subscribe to the specified event stream.

‚Äč