Webhook Quick Start
Last updated
Last updated
We are still finalizing this documentation, but you can create your webhook destination and begin receiving events already. In the meantime, please refer to our other documentation on Event Streams.
To create a new Webhook destination, go to the navigation bar on the left side of the screen and click on the Destinations option. This will open the Destinations page. Select the +Create button to add.
Provide a friendly name and select the destination type "Kore Webhook" then click on continue.
Provide your Webhook configuration by filling in the following inputs
Destination URL : Provide a secure HTTPS endpoint that allows kore to access and send HTTP request to your service, please consider the following
The URL must begin with "https://"
Ensure that your service has a valid SSL/TLS certificate installed
Method : Indicate the desired action to be performed when sending a HTTP request to your destination, select Get or Post method.
This step is optional but encouraged because it ensures KORE and your destination can successfully communicate before trying to stream events to your destinations.
Review our guide on how you can test your destination.
Click on the Event Stream option from the left sidebar menu.
Click on Streaming rule from the drop down side menu.
This will open the Rules page. Select the +Create button.
Provide your rule configuration, filling in the required fields for the rule configuration:
Rule Status :
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
Rule Name: A unique identifier for the rule you are creating.
Destination: The endpoint where the events will be sent.
Product: Select the product group relevant to your events.
Clicking on the schema version drop-down for each event type. 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.
The data you receive will follow the formats as designed:
Review our guide to see an example of this.
