Webhooks
This documentation applies to the following products:
Super SIM
Programmable Wireless
Ensure you follow the guide to link your Twilio account to KORE before continuing.
For all other products, please review their respective documentation.
Follow these steps to start receiving Webhook events from KORE.
1. Securing your Webhook - Secret Generation
Securing your Webhook with a secret isn't mandatory, but KORE strongly encourages you to validate that the Webhook comes from KORE.
The secret should only be known by you and KORE. Treat this as you would your password, and do not share it.
To create your first KORE Webhook secret, login to the Developer Portal, navigate to Webhook page, and click on Create.
Provide a friendly name to your secret and click Create.
View or download the newly created Secret and save it.
A secret is visible or downloadable only at the time of creation. If you forgot to save it, review our guide to rotate your secret to generate a new one.
The newly created secret details will be listed.
Once you have generated your first Webhook secret, all Webhook callbacks from KORE will be signed, and you can then validate.
2. Test your Webhook Endpoint
Coming Soon
We are working on releasing this feature to improve your developer experience
KORE allows you to send test events to an endpoint you wish to use to receive events from KORE. You can do this through the UI or API.
We suggest you test your Webhook Endpoint to
ensure KORE can successfully send you events
understand and validate all the headers from KORE, specifically to validate the Webhook
troubleshoot problems before leveraging Webhook with a product
Review our guide on testing and troubleshooting your Webhook for more detailed steps.
3. Configure a Webhook URL with the Super SIM API
The assumptions are:
You have created an API client to make API calls against KORE with a Super SIM scope; if not, review the getting started guide.
You have SIMs in either an Active or Inactive state.
We will configure a Webhook on a Super SIM API endpoint to get started and flip a SIM's status from inactive to active.
Activating a SIM will incur a monthly SIM fee and any data charges you generate.
With your API token and Super SIM SID, make the following API call to activate your Super SIM ensuring you specify a value for CallbackUrl
.
4. Receiving and Responding to Webhook
Once you submit your API call with a Webhook configured, you will receive a callback from KORE with the HTTP headers mentioned here ( a sample is shown below).
Upon receiving this, you should respond back with a 2xx HTTP response code. Also any temporary failures (HTTP response codes of 408, 429 or 5xx) will be retried.
Next Steps
🎉 Congratulations! You have successfully configured and received a Webhook from KORE.
You can explore KORE's various other APIs to get started with other products.
Last updated