We send webhook notification in JSON format on several events. You can set up your notification URL in your account. Here you can see the example notifications.
We send account emails for low account balance and payment confirmations.
Notifications:
- ORDER_STATUS – Ordered eSIM(s) are ready for download
- ESIM_STATUS – eSIM is in use
- DATA_USAGE – eSIM Data is 100Mb or less
- VALIDITY_USAGE – eSIM validity is 1 day
You can test the JSON payloads by converting the JSON to an URL query string with this tool.
Try our for for sending these notifications to your endpoint.
Webhook testing #
Order status example:
https://your.webhook.resource.com?notifyType=ORDER_STATUS&content[orderNo]=B23110718759768&content[transactionId]=test&content[orderStatus]=GOT_RESOURCE
eSIM in use example:
https://your.webhook.resource.com?notifyType=ESIM_STATUS&content[orderNo]=B23122613010998&content[transactionId]=ord_658adb14bcebb413862417&content[iccid]=8943108170000828413&content[esimStatus]=IN_USE&content[smdpStatus]=INSTALLATION
eSIM low balance example:
https://your.webhook.resource.com?notifyType=DATA_USAGE&content[orderNo]=B23110718759768&content[transactionId]=5102378090678&content[iccid]=89852000263318806140&content[totalVolume]=121313&content[orderUsage]=232&content[remain]=12123
eSIM low validity example:
https://your.webhook.resource.com?notifyType=VALIDITY_USAGE&content[orderNo]=B23121208751454&content[transactionId]=23121208994478&content[iccid]=00000002610900000479&content[durationUnit]=DAY&content[totalDuration]=30&content[expiredTime]=2024-01-11T08:10:19Z&content[remain]=1
Visit docs.esimaccess.com for more.