Location: Contacts Tab > Webhooks
Step 1 Create A Webhook
Start by entering information for the Title, Webhook URL and Method.
- Title: We suggest something like "Bluerock - *Name of Campaign*", this will assist you later when if you have multiple Webhooks for multiple campaigns.
- Webhook URL: Paste https://web102.4bsi.com/communicator/ into the input field. This should be the same for everyone posting to Bluerock.
- Method: Select "Post"
- Port and Authentication: Leave blank they will not be used for this post.
Once you have entered this information click "Save Webhook".
Step 2 Add Fields To Webhook
Next you will enter the key value pairs that will be posted into the Bluerock campaign.
Once you hit "Save Webhook" you should see some new options appear below the general Webhook settings. We will be adding the Key Value Pairs here. The Field Name is the Key Bluerock will want passed to them, it is used to identify the information being passed into their system and needs to match as they expect it from in their system. They will need to be enter verbatim for the Webhooks to function successfully. The Value is the data we are actually passing for the key. For example the Key "first_name" would pass the value "Jeff" if the data saved on the contact for first name is "Jeff'.
Adding a Standard or Custom Field
First enter the Key (Field Name) as provided from the table below, we are adding the Key Value Pair for the contact first name to be passed into Bluerock. Again, this needs to be enter exactly as Bluerock expects it, enter the Key (Field Name) exactly as provided in the table below. Next the drop down menu for Value contains all Custom Fields and Standard Fields. For Key (Field Name) where you are passing one of these you will simply select the field from the drop down menu like in the example above (we have selected the standard field "First Name"). Once ready click the green circle icon with a "+" symbol enclosed and the value pair will be added to the Existing Fields of the Webhook as displayed below.
Add a Customer Value
In some cases you will want a constant value passed for the Key (Field Name). In the example above we are adding a Key Value Pair for the Bluerock campaign, so we will want the value for that Key (Field Name) to be passed with the same value every time the Webhook runs. Start as normal and enter the Field Name as provided in the table below; "campaign". Next in the Value menu select "---Custom Value---", another input field will appear for you to then enter the constant value that will be passed for that Key (Field Name). This means for our example every time this post runs it will pass the Value "example" (the campaign name in Bluerock) for the Key (Field Name) "campaign".
Field Table - Below is the table of fields and values you will want to add to the Webhook
| Field Name | Value | Notes |
| action | post | Constant entered as "---Custom Value---" |
| insert_method | insert | Constant entered as "---Custom Value---" |
| reference | ID | System field found in drop down menu |
| priority | Usually "10" but can be a range between 1 - 10. This is used to set the priority of the contact in Bluerock so they are higher in the call queue of the campaign. Generally they will automatically lower the priority of older leads and want new leads to come in at the highest priority. | Constant entered as "---Custom Value---" |
| first_name | First Name | System field found in drop down menu |
| last_name | Last Name | System field found in drop down menu |
| System field found in drop down menu | ||
| phone | {ANYPHONE} | Constant entered as "---Custom Value---" |
| aid | Same as found in the Bluerock Settings | Constant entered as "---Custom Value---" |
| hash | Same as found in the Bluerock Settings | Constant entered as "---Custom Value---" |
| campaign | Provided by Bluerock | Constant entered as "---Custom Value---" |
| mod | webdialer | Constant entered as "---Custom Value---" |
Once setup your webhook should appear similar to below.
Step 3 - Implementing the Webhook
Most likely you will want to add the WebHooks to a Data Source so that leads imported will be immediately posted out to the Bluerock campaign to be called. To start go to the Contacts Tab > Data Source. Once on the Data Source screen select the data source you want to add the Webhook to. Scroll down to the bottom below the Assignment Options and find the WebHooks section (enclosed in red box below. Highlight the Webhook you want to use with the Data Source and click "Save Data Source" on the navigation bar. Now any time a lead is imported thru this Data Source the
This is the most common use for using a Webhook to Post into Bluerock. You can explore other options for implementing Webhooks on the main article available here.