A webhook (in the specific usage in btPRO) is a link that is sent from one computer to another (as opposed to you visiting the link in your browser.) When this link is used, it can trigger some automated service that uses the information in the link to do something special.
Webhooks can be complicated. If you're familiar with Zapier, a popular alternative to webhooks is a Zapier Campaign action.
Webhook Example
Let's say that you want to send a custom Seller postcard or some other mailer as part of a Smart Campaign for Sellers. Maybe it's the very first action that happens when they become a new contact in your system.
It's possible to do this in btPRO as long as you have the following items:
Information the postcard needs (a name, address, maybe a valuation amount, etc).
A web service that can mail out postcards for you, using the information above. Specifically, a web service means that this third-party postcard or mailer provides you with a webhook format that you can use.
An automated process (Smart Campaign) that triggers the webhook at a specified time.
Let's say you work with a third-party postcard mailing service to accomplish this. For the sake of the example, let's also say that the reason to use their service is that in research or inquiry to them, it was confirmed they can send postcards from a webhook. Let's say you can have postcards mailed on demand. It will cost you $0.90 per card mailed within the continental U.S., etc.
What you need to make sure of, is that their webhook allows you to send data using the 'GET' method. This is important because it is the method that the webhook action in kvCORE uses. If they describe to you or send you their documentation that has a bunch of programming, it probably is going to use, or it will show you that it is using an HTML 'POST' method to generate the card and send. btPRO does NOT use 'POST.'
What's the difference? The GET method will allow you to build a link like the one described at the beginning of this article very easily. POST is more complicated, and in order to implement will require you to actually write code.
That 'GET' link will look something like this:
In btPRO there are quite a few variables (A.K.A Query Parameters) available. Everything from various pieces of lead contact information to even your information can be used.
This link has a few places you can insert variables. In looking at links like this, they all seem to have this pattern in them that is an = followed by an &.
These are the spaces in which your variables will go. To simplify it into plain English, read the link like name= AND address= AND price=. That tells you where to put your variables.
You can see where the {variables} were entered that should feed to the webhook.
If you're curious about webhooks and want to learn more, there is an in-depth write-up on the Zapier blog full of great information! To learn more about webhooks click here.
How To Use Webhooks in btPRO
In btPRO you can create webhooks with templates. Templates are the actions that can be used for both emails and Smart Campaigns (See canned responses for more information if you are not already familiar with templates.)
Navigate to templates, and select 'Webhook' from the add list.
Adding A New Webhook
Name - Name your webhook.
Scope - Choose who can see this webhook in the templates list.
URL - Paste the base URL+Auth Key of your webhook here.
MLSID - This only shows if you select a listing query parameter below.
Query Parameters - Enter the name of the query string parameter that will be used in your URL and then select which value it should equal to in the drop-down menu. The query string parameter name will be the name expected by your webhook.
Add - After adding your first parameter, the 'Add' link will show.
To fill out this modal, we'll break down the hypothetical URL for the postcard mailing service-themed example.
Base URL - The beginning part of the URL, before the '?' is what goes into the 'URL' field in the modal.
Query Params - Each Query Parameter has a 'label' that tells the API service at the third party which piece of data goes where.
= - Each time you have a label, it's followed by an equals sign.
& - After every variable, the & symbol indicates that the next label follows.
As you can probably guess, we need to extract each label, and add it as a Query Parameter, and select the variable from the list to the right.
After clicking 'Add Webhook' you will see your newly minted webhook in the list.
Now, in Smart Campaign, you can add the new webhook with a Campaign action. (When you edit a smart campaign, you can add or modify the "actions" or "events" that happen at specific times.)
For the example we want this to send right away, therefore you'll set it to send immediately.
If you give the webhook and Campaign action a clear name, the report in the timeline tells you exactly what took place.
That's it! You can now basically connect kvCORE to any third-party services that use webhooks, increasing the power of your system exponentially.
Related Articles
If you have any questions or need assistance, please reach out to Customer Support via the blue chat bubble to the right or by emailing prosupport@insiderealestate.com!