Streaming Rules
Last updated
Last updated
A streaming rule tells KORE which events you wish to stream to which destination. You can manage all your streaming rules through the developer portal.
You will not see any streaming rules when you log in for the first time. You can review our getting started guide to stream KORE events to start consuming events from KORE.
When you have one or more streaming rules created, you will see them in a table.
When reviewing the details of a streaming rule, you will be presented with a read-only view, which you can edit.
Clicking on the destination name will take you to the details of that destination.
Once created, a streaming rule has properties that help KORE understand, for example, what events you want to be sent and to where. These properties can be modified at any point.
When you create the rule, you can specify whether it will be enabled or disabled upon creation, which you can change after.
Enable Status - Any events that trigger the streaming rule will be streamed to your destination
Disable Status - Any events that trigger the streaming rule will not be streamed to your destination
When you create your streaming rule with a status of Enable, KORE will start sending events to your destination, for which you may incur a cost from your cloud provider.
We encourage you to set the status as Disable if you are either not using the rule or are not ready to consume the events to minimize unnecessary costs by your cloud provider.
The destination you specify in the streaming rule tells KORE where you want to receive the events.
When creating a rule, you must specify a destination, which you can modify later.
Review our destination docs for more details.
You can see all the streaming rules a destination has by reviewing the details of the destination.
Each streaming rule has a name so that you can identify it quickly.
You are required to specify a name when creating the rule, which you can edit after.
The property group is a filter for you to go through all of the events KORE has available.
The event types are broken down by product, each with its own event data schema and schema version. You can apply the same schema version to all event types or select which events and their schema version you want.
Selecting a schema version for an event triggers your rule to subscribe to those events. Your rule doesn't listen to that event if no schema is chosen. You can always edit the event types to which your rule is subscribed.
If you use 'Apply All' to apply the same schema to all event types, you will receive every event available for the product, which may incur additional costs.
You can view the event types available to subscribe to at the time of creation or when editing your streaming rule by either
Clicking on the drop-down under 'Apply All,' or
Clicking on the schema version drop-down for each event type.
