Skip to main content
All CollectionsGetting startedOnomondo app featuresWebhooks
How do I set up a Webhook on my account?
How do I set up a Webhook on my account?

Webhooks are a great way to receive real time events to a URL endpoint based on the use cases you require

Benedicte avatar
Written by Benedicte
Updated over a month ago

To increase the security of data transfer, please ensure that your endpoint is hosted on a secure HTTPS web server. You can either use an endpoint provided by services like Zapier or develop your own, but make sure it has at least SSL encryption.

How to add a default Webhook

Once you have set up the endpoint for the Webhooks, copy the URL and go to the Webhooks section of the Platform. Click create a new Webhook. The simplest is just a global Webhook that sends all events.

URL endpoints need to be unique. Two Webhooks cannot have the same URL. They can be different sub-directories of an URL.

There are six kinds of events of Webhooks:

  • Network Authentication - the device has asked to attach to the network.

  • Network Registration - the device has attached to the network.

  • Network Deregistration - the device has detached from the network.

  • Data usage - per SIM, is updated every 15 minutes of activity or when a SIM de-registers from a network.

  • Device SMS - when a device sends a SMS to any number.

  • SMS usage - separately for both outgoing and ingoing

  • Location (approximate) - of a SIM at the beginning and end of a session and when the location changes during a session.

  • Usage alerts - when a device reaches a Usage Alert Threshold (optional) or is blocked by Usage Limit.
    ​


How to edit a Webhook

It is easy to also edit a Webhook.

Go to the Webhooks tab in the Onomondo app and click the "Edit" icon next to the previously created Webhook.

You can edit:

  • Name

  • URL

  • Tags

  • Active status

  • Events

When you're done making changes, click "Submit". Your updates will take effect immediately.
​


Customizing Webhooks for use cases

IoT deployments can quickly become large. Receiving all events for all SIMs and altering it on the backend requires development time and resources. Taking advantage of Tags, Webhooks can be customized for specific uses.

Use Case Examples:

  • Tracking network registration events in a test country

  • Monitoring data usage

  • Catching SMS error codes from a legacy device

  • Monitoring events of a development kit to help monitor how it is functioning

  • Mapping location events of a specific product
    ​

What is the data being sent?

You can find more information about the data structure of different Webhooks events in the relevant section of our API documentation.

If you have any further questions, you are welcome to send us your questions to [email protected].

Did this answer your question?