Webhooks are a powerful dynamic resource in which apps (i.e. smrtPhone) can send automated messages or information to other apps (i.e. your CRM) and you can use this to improve your productivity.
In smrtPhone, you can generate Webhooks from Events. These signals are real-time, rather than waiting for a scheduled update from an API.
This article will cover the most useful key points in using Webhooks within the smrtPhone system:
Where to Access Webhooks
The Webhook interface lives inside the Admin Panel in the smrtPhone Dashboard.
How to Create a New Webhook
Once you are in the Webhook interface, it's easy for you to create a new one. Click the upper green button ➕ New Webhook.
Now you can set up the details for this new Webhook:
Our initial set of events is focused on phone number management, such as purchasing a new number. We will continue to add to the list of available events.
A common example is if you have your CRM configured to send automated text messages from your phone numbers. When you purchase a new number, you will want to update your system to use that new number to send messages as well. Instead of having it be fully manual to do so, you can set the Webhook for Buy a number to trigger a new SMS sequence creation within your CRM.
If you have ideas for other ones you want, please add them as a feature request ⇢
This is the URL you define, where the Webhook event information will be sent. It belongs to the receiving system (for example: your CRM.)
Events are the activities and triggers within smrtPhone that will send out the Webhook. At the time of launch, the available events are related to phone number management. We will continue to add events and expand our Webhook capabilities.
While selecting, you can choose one, multiple, or all of the events available in this list.
For example: You can create a Webhook that alerts your system that you have purchased a new number with a specific friendly name.
Each event can trigger whatever you want within your system. That part is up to you/your developer.
Name of the event
Action that happened in smrtPhone
🔕 Add number to DNC
A contact has opted out and their number has been added to the smrtPhone Do Not Contact list.
📤 Remove number from DNC
A contact has opted-in and their number has been removed from the smrtPhone Do Not Contact list.
🔢 Buy number
A new phone number has been added to your smrtPhone phone number portfolio.
✂ Delete number
A phone number has been removed from your smrtPhone phone number portfolio.
🔼 Update number Friendly name
A phone number has a friendly name added or modified.
📵 Add number to Spam
A phone number has been marked as Spam.
📲 Remove number from Spam
A phone number has been removed from the Spam List.
This field is optional, yet it can help you keep track of each event. You can use this description of an Event in searching for them.
Once you are happy with the settings, click the Save button. You can always come back later and edit these events.
Filter and Find Webhooks
If you have a long list of Webhooks, you can quickly find them by using the filters available from the main Webhook interface.
Also, you can sort them by the date they were created or their status.
After the Description column, where you can see any description if set, the final option is to edit or delete the Webhook from the icons in the Action column.
Using Webhooks & Proper Payloads
Depending on which Webhook you are using, you will need to configure your system to receive all of the correct information. This is commonly referred to as the "payload." You must ensure all proper tokens are sent and received for the Webhook to perform correctly.
For each event, you will receive a specific JSON payload, as in the examples below:
Add Number to DNC:
Remove Number from DNC:
Update Friendly Name:
Add Number to Spam:
Remove Number from Spam:
Webhook View Logs
In Logs, you can find information for each specific event that occurred.
Here you can see the names of the events, the status of each of them, the Payload attached, and if any errors occurred.
See the details about the Payload by clicking the Show button.