Test My Destination

We encourage developers to test and validate their destinations when creating them to verify whether their destination and KORE can communicate.

This guide assumes you have already set up your destination on your infrastructure and created the destination at KORE to start sending and receiving events. Review our getting started guides for more details.

Send Test Events to the Destination

  1. Click on the Destinations option from the left sidebar menu.

  2. Select your desired destination from the grid.

  3. Once you are on the destination detail page, select the action drop-down from the top right-hand corner.

  4. Click on Test Event to trigger the test.

The testing process may take a few seconds to send test events because we will attempt to connect with your destination before sending test events.

If the test is successful, you will see a confirmation message indicating that the connection has been established and the test event was sent successfully.

An error notification will appear on your screen if the test is unsuccessful. Please verify your destination settings.

Verify AWS Kinesis Test Event

This End-to-End Verification allows you to confirm that data flows correctly from your source system through Kinesis. We also recommend validating that your shard count and retention period are set correctly in AWS based on your use case.

Here is an example of the test event payload

{
  "data": {
    "test_id": "88bf54a9-f2fb-40b6-8faf-e6c5a3c348d2"
  },
  "id": "fff521c2-c7db-4b53-a5a0-c5d5d01f66ce",
  "time": "2024-09-25T19:09:48.5842087+00:00",
  "type": "com.kore.eventstreams.test.event",
  "source": "kore-events",
  "dataschema": "/schemas/test/1",
  "specversion": "1.0",
  "datacontenttype": "application/json"
}

Verify Webhook Test Events

If you're not using event streams but are using callbacks, you can still use this guide to validate that your callback URL and KORE can communicate.

You can also use the guide to see how KORE signs Webhooks.

If your Webhook service is operational and accessible, you should receive an HTTP request at the specified endpoint. During this testing process, please consider the following important details:

  • HTTP Method: The request will use either GET or POST, depending on your configuration. Ensure your endpoint can handle the method you've specified.

  • Request Headers: Pay special attention to these Kore headers:

    • kore-idempotency-token: contains a unique value for each request. You can use this token to implement deduplication logic, preventing duplicate processing of the same webhook request.

    • kore-signature: KORE signs all inbound Webhook requests to your application with this header. It's crucial to verify the authenticity of the requests. Review our guide on how to validate webhook signatures.

  • Content Type: The request will have a content type set to application/json. Your service should be prepared to parse JSON data.

  • Encoding: The character encoding for the Webhook request payload is set to UTF-8 (charset=utf-8). When processing the incoming requests, ensure that your system is configured to interpret the payload using the same encoding to avoid potential character misinterpretation or data corruption.

  • Quickly return a 2XXResponse: KORE's suggested best practice is to respond with a 2XXresponse as fast as possible to avoid timeouts.

A successful test confirms that your system is correctly set up to receive WebHook notifications such as:

Here is an example of the test event payload for webbooks:

[
  {
    "data": {
      "test_id": "88bf54a9-f2fb-40b6-8faf-e6c5a3c348d2"
    },
    "id": "fff521c2-c7db-4b53-a5a0-c5d5d01f66ce",
    "time": "2024-09-25T19:09:48.5842087+00:00",
    "type": "com.kore.eventstreams.test.event",
    "source": "kore-events",
    "dataschema": "/schemas/test/1",
    "specversion": "1.0",
    "datacontenttype": "application/json"
  }
]

Please note that a single Webhook payload may contain multiple events. Our system employs a batching mechanism for efficiency. If several records for the same event type are generated within a brief interval, they will be consolidated into a single request.

Last updated