Incoming SMS Webhook
You can set an Incoming SMS Webhook URL for each SMS service from the SMS Service Configuration page.
When a webhook URL is saved, inbound SMS messages for that service are delivered to the URL by
POST using the current v2 payload.Where to find it
Step 1: Sign in to the Atomic portal.
Step 2: Go to Services > SMS Services.
Step 3: Open the SMS service you want to update.
Step 4: Select the Incoming SMS Webhook tab.
Step 5: Enter the Inbound SMS Webhook URL.
Step 6: Click Update.
The tab appears after Sender ID and before Email to SMS.
Webhook URL requirements
The webhook URL is optional. If you add one, it must:
- Start with
https:// - Include a valid host
- Be 1024 characters or less
- Not include embedded username or password credentials
Examples that will not be saved include
http://..., javascript:..., invalid URLs, hostless URLs, and URLs longer than the allowed limit.Your web-hook service will receive messages as per the below schema. The webhook is a RESTful service that enables your service to process the interchange of JSON formatted messages via HTTPS protocols.
text
{
"to": "61456789012",
"from": "61499888999",
"timestamp": "2022-06-28 21:53:47",
"type": "text",
"message": "This is an incoming SMS test.",
"id": "210181"
}Clear the webhook URL
To remove the webhook URL for the service:
- Open the Incoming SMS Webhook tab.
- Clear the Inbound SMS Webhook URL field.
- Click Update.
Clearing the field removes the per-service webhook URL.
This setting is saved per SMS service. Updating it does not change the Service Settings tab or re-run SMS service plan/provisioning updates.