Onoff Business – SMS Webhook Integration Guide
The Onoff Business SMS Webhook allows your system to receive real-time SMS activity directly from Onoff Business.
This integration is ideal for businesses that want to:
- Store SMS data in internal systems
- Automate workflows based on incoming or outgoing messages
- Build analytics dashboards
- Sync SMS activity into CRM or BI tools
The webhook delivers SMS metadata and message content immediately after the message is sent or received.
SMS webhook is available on Onoff Business Advanced and Max plans.
Installing and Configuring the SMS Webhook
- SMS Webhooks require Advanced or Max plans
- If you don’t see Integrations in your menu, update your plan or contact your admin
Open the SMS Webhook Configuration
- Open Integrations & API on the main page
- Click Onoff SMS Webhook
- Configure the following fields:
- URL (required): Your server endpoint to receive POST requests from Onoff
-
API Key (optional, recommended): Secure your endpoint and verify incoming requests
You can find more details in the Documentation of the webhook (go to Authorization section).
Activate the SMS Webhook
- After filling in the fields, click Integrate
- Onoff sends a test payload to your URL
- Webhook status updates:
- Integrated : if your endpoint responds correctly
- If the test fails, you must correct the URL to enable the webhook
Data Sent by the SMS Webhook
For every SMS sent or received, the webhook payload includes:
- User information: username, email, Onoff number
- External number: the recipient or sender
- Contact name and email: if saved in the user’s Onoff contacts
- Date & time
- SMS direction: SENT / RECEIVED
- SMS message body
Example: Full payload details can be found in the official documentation:
➡️Onoff SMS Webhook Docs
Webhook Behavior for SMS Events
- Triggered immediately after an SMS is sent or received (no delay)
- SMS content is included in the body field
- If the external number exists in the user’s Onoff Contacts, additional info is sent:
- Contact name
- Contact email
- Company (if available)
There are no post-update windows, SMS events are final
Removing the SMS Webhook
- Go to Integrations and API → Onoff SMS Webhook → Settings
- Scroll to Remove and confirm your choice (red button).
Notes:
- No new SMS events will be sent after removal
- Past events already delivered remain in your system
- The webhook can be reactivated anytime by reinstalling
- Secure your endpoint with the optional API Key
- Use the webhook to automate workflows and feed data into analytics tools or CRMs
- Expect SMS events to be instantaneous, unlike call recordings
- Ensure your endpoint can handle real-time payloads to avoid missed messages
Your SMS Webhook is now ready. All incoming and outgoing SMS messages from Onoff Business will flow directly to your system in real time.
Comments
0 comments
Please sign in to leave a comment.