Before you start
Auvik sends each alert straight to the BulkSMS API using its built-in webhook feature, so there is no extra software to install.
You need permission to manage Integrations and Alerts in your Auvik account, and a BulkSMS account with credits.
Have the mobile numbers to alert ready, in international format without the leading zero, for example 447700900123.
If you want alerts to come from your organisation's name, request a Sender ID early (see Sender (from) address), as approval can take up to one working day.
Create a BulkSMS API token
Log in to your BulkSMS account and go to Settings > Developers.
Click Create API Token and give it a name, for example Auvik. Copy the Token ID and Token Secret. The secret is only shown once.
Add a BulkSMS webhook integration
In Auvik, open Integrations, hover over Add Integration and choose Webhook.
Fill in the form with your BulkSMS details:
| Field | Enter |
|---|---|
| Integration name | BulkSMS |
| Webhook URL | https://api.bulksms.com/v1/messages?auto-unicode=true |
| Authentication | Basic Authentication |
| Username | Your BulkSMS Token ID |
| Password | Your BulkSMS Token Secret |
In Apply transformation here, paste the expression below. Replace the example number and message with your own:
{
"to": "447700900123",
"body": "Network alert from Auvik. Please check the dashboard."
}
Click Test Connection, then Save. The test may send a real SMS to the number in your expression, which uses a credit.
auto-unicode=true tells BulkSMS to send messages that contain special characters (such as é or ü in a device or site name) as Unicode, so they arrive correctly instead of turning into "?".
Choose which alerts send an SMS
In Auvik, add a Notification Channel: give it a name, set Contact Method to Webhook and select the BulkSMS integration.
Open each alert you want texted (for example, device offline, or Critical and Emergency alerts) and add the BulkSMS channel under Notification Channels.
Save, then trigger or wait for an alert to confirm the SMS arrives. Only alerts with the BulkSMS channel attached send a text.
Customise your alerts
Add alert details: to include details from each alert, join your text (in quotes) to Auvik fields with &:
"body": "Auvik " & alertStatusString & ": " & alertName & " - " & entityName
This sends, for example: Auvik Triggered: Device offline - Core-Switch-01
Useful fields: alertName, alertStatusString (Triggered or Cleared), alertSeverityString, entityName (the device) and companyName (the site).
Text more than one person: put the numbers in square brackets, separated by commas:
"to": ["447700900123", "447700900456"]
Long messages: leave longMessageMaxParts as the default, 3. Messages over 160 characters (or 70 characters when sent as Unicode) are split into up to 3 parts, so an alert may use up to 3 credits.
For every available setting, see the BulkSMS API documentation. For all Auvik alert fields, see Auvik's webhook payload guide.
Sender (from) address
The sender address is what staff see in the "from" field of each alert text. A recognisable name helps people trust and act on an alert quickly, especially at 2am.
| Option | How it works |
|---|---|
Sender ID"from": "YOUR_APPROVED_SENDER_ID" |
Best for alerts. A name of up to 11 letters and numbers, with no spaces or special characters. Recipients can't reply. It needs to be requested and approved first (see below). |
Repliable number"from": {"type": "REPLIABLE"} |
Texts come from a number that staff can reply to, for example to acknowledge an alert. Replies appear in your BulkSMS account. |
| Your own mobile number | A numeric sender must be an existing mobile number that's verified and linked to your BulkSMS account. |
| Not set | Leave out the from line (as in the example above), and your account's default sender setting is used. |
To request a Sender ID: in BulkSMS, go to Settings > Message Settings > Sender IDs, click Request Sender ID and enter the name you want, such as your organisation or team name. We'll let you know within 1 working day whether it's approved, or if we need more information.
Only add the from line once your Sender ID is approved, replacing YOUR_APPROVED_SENDER_ID with your approved name. Until then, leave it out so alerts still go out. If the name includes a brand, we may ask for proof that you're connected to it. You can read more about Sender IDs, or email support@bulksms.com with the subject "Register a Sender ID".
Sending tips
Two messages per incident: Auvik sends one message when an alert triggers and another when it clears. Add alertStatusString to your message so each text says Triggered or Cleared.
Usually one credit per alert: most alerts fit in a single SMS. A long message, or one with special characters sent as Unicode, can use up to 3 credits.
Times are UTC: Auvik's webhook timestamps are in UTC, so they run an hour behind UK time during British Summer Time.
Watch for alert storms: if a core device goes down, every device behind it may alert too, and each one sends a text when it triggers and again when it clears. Keep the BulkSMS channel on your most important alerts to avoid a flood of messages.
Several recipients: every number in the "to" list gets each alert. Remove numbers there when people come off the on-call rota.
Troubleshooting
Test Connection fails: check the Token ID and Token Secret, and that the Webhook URL is exactly as shown above. If it still fails, add a header under Additional HTTP headers: Key Content-Type, Value application/json.
Alert fires, but no SMS arrives: check that the alert has the BulkSMS notification channel attached, and that your account has credits.
Texts stop after adding from: check that your Sender ID has been approved and is 11 characters or fewer. Until it is, remove the from line.
Sender shows as a number, not your name: your Sender ID isn't set or approved yet. See Sender (from) address.
Characters show as "?": add ?auto-unicode=true to the end of the Webhook URL.
Message shows as failed in BulkSMS: check the number is in international format without the leading zero, for example 447700900123.
Too many texts: remove the BulkSMS channel from lower-priority alerts, and keep it on Critical and Emergency alerts only.
All setup and ready to go!
If you have any questions, please contact our support team. Include your account name and put Auvik in the subject line, and we'll be happy to help.