You are able to setup Webhooks in order to post information out of the CRM to other systems. You may do this to integrate outside systems. You can setup a HTTP Post using a GET or POST methods.
Location: Contacts Tab > WebHooks
To create a WebHook you will need to get posting instructions from the system you are going to be sending information to. They will most likely provide either a URL and a set of Keys to pass or a example posting string containing the URL and Keys. In the example below we are posting a simple set of data. The contacts first name, last name, phone number and state code.
Examples
URL with Keys: The example information below is where the posting instructions have been provided with a URL and then keys that will be passed.
Post URL: https://client.debtpaypro.com/post/f16b3893c9cf77f6348fa42444979913a6dad41a/
Keys
Sample String: Below is an example where a sample string has been provided, which is simply the Posting URL including all the keys that should be passed. Notice the information is listed in one long string and starting at the '?' the keys are separated by a '&' symbol. After each parameter is a sample set of data. The first Key is included as "firstname=test". This means we are passing the Key "firstname" with the value "test". This is referred to as a Key Value Pair. For ever Key there is an associated data you are passing as it's value.
https://client.debtpaypro.com/post/f16b3893c9cf77f6348fa42444979913a6dad41a/?firstname=test&lasname=test&phone=5555555555&state=CA
If given a sample string you will want to separate the Post URL from the Key Value Pairs like below. Having the URL and Keys organized this way will help you when entering the data for the WebHook properly.
https://client.debtpaypro.com/post/f16b3893c9cf77f6348fa42444979913a6dad41a/
firstname=test
lasname=test
phone=5555555555
state=CA
Now that we have our posting information we can setup the WebHook. Start by entering a Title, WebHook URL and select the method. If you are unsure of the method select POST to start with. During testing you can switch to GET if the post fails to function correctly with the POST method. If Posting instructions have indicated the need to set the Port and/or Authentication Username and Password you can enter them at this point as well. The Port and Authentication are not required for the WebHook to function. Also, do not mistake the Authentication Username and Password for Key Value Pairs that your posting instructions indicate need to be passed.
*The Authentication refers to Access Authentication which is separate from the actual WebHook's URL and you can use Basic or Digest Types if authentication is required.
Once you have entered information, click "Save WebHook" and move to the next step of adding the Key Value Pairs.
1. Enter the Key in the Field Name input field
We will now be adding the Keys and then mapping data points from the CRM for the value we will be passing. Start by entering the key as provided in the posting instruction or sample string.
*Important: The key must be entered exactly as it exists in the system you are posting to. In our example the instruction provided uses "firstname" as the Key. If "Firstname", "First Name", "fname" or anything straying from the instructed "firstname" is used the post will not work. The Key MUST be entered verbatim to what is provided, no changes to case, spacing or spelling.
2. Now Map the Field from within the CRM to the Key
The next step is to map together the data point from within your CRM to the Key. This enables so that the value saved on a contact for that data will be passed as the value of the key. In our example below we have mapped the system field "First Name" to the Key "firstname". This means when the WebHook runs the value for the system field "First Name" will be passed as the value for the Key "firstname". For example if the contact's first name is saved as "Mike" the Key "firstname" will be passed with the value "Mike". Once you've selected the data point you wish to use, click the green circle icon with the white plus symbol to add it as a Key Value Pair.
*Constant Value - In the case you need to pass a constant value lfor a Key like a API hash or password you can select "Custom Value" for the value and a third input field will appear for you to enter a constant value that will be passed for the Key.
3. Double Check and Confirm
Now that you have added all the Key Value Pairs for the Webhook it is best practice to double check that everything has been inputted correctly. Again if any Keys are spelled incorrectly or differing in anyway from what was provided in the posting instructions or sample string the value will not be passed. The accepting system of the post will not be able to capture the data since it is not looking for a Key that doesn't exist in their system, they won't know what to do with the incorrect Key and usually omit it.
1. WebHook Triggers
Location: Linked on WebHook setup page on the left side; "Setup WebHook Triggers"
Similar to eMail Triggers you are able to setup so a system event can trigger the WebHook to run. For example if you use a phone dialer and have a call queue dedicated to calling clients who's payment have been returned. You could setup a WebHook that posts contact information to the call queue in the dialer. Then setup a trigger to use the WebHook in the event a payment has been Returned / NSF.
2. Mass Post
Location: Contacts Tab
Similar to Mass Editing you are able to push a group of leads from the contacts tab. The option will be located in the same drop-down menu as the Mass Edit and Export functions. While viewing the contact tab you will need to select either "With List" (post the entire list you are viewing) or "With Selected" (post only contacts you've selected by checking the box next to their record on the list table). In the example displayed below we have selected "With List" so all 43 contacts will be posted, If we selected "With Selected" we would only be posting the 3 contacts who's boxes we have checked. Once you have made your selections click the green circle icon with a check mark next to the drop-down menu.
Once you clicked the icon you will be taken to the Mass Post page. First select the WebHook you want to post through from the drop-menu displayed. Once you've selected the WebHook a preview of the data you will be posting is displayed. Click "Next Record" to scroll through some of the other records you will be posting to check the data. Once you have confirmed everything is ready click "Post Data". Depending on the number of records you are posting the amount of time it takes for the WebHook to run will vary, once finished you will be taken back to the Contacts Tab.
3. Automatically Post from Data Source
Location: Contacts Tab > Data Source
As part of importing lead via Data Sources you can also have information posted out via a WebHook. You'll find the option to select a WebHook to post through on import at the bottom of the Data Source. Simply highlight the WebHook you wish to use and then save the Data Source. Now the next time a lead is imported through the Data Source it will also post out through the WebHook.
For more information on Data Sources please visit our artcles for setting up an Import or WebForm Data Source
Location: Contacts Tab > WebHooks
Posting Instructions and Sample Strings
To create a WebHook you will need to get posting instructions from the system you are going to be sending information to. They will most likely provide either a URL and a set of Keys to pass or a example posting string containing the URL and Keys. In the example below we are posting a simple set of data. The contacts first name, last name, phone number and state code.
Examples
URL with Keys: The example information below is where the posting instructions have been provided with a URL and then keys that will be passed.
Post URL: https://client.debtpaypro.com/post/f16b3893c9cf77f6348fa42444979913a6dad41a/
Keys
- firstname
- lastname
- phone
- state
Sample String: Below is an example where a sample string has been provided, which is simply the Posting URL including all the keys that should be passed. Notice the information is listed in one long string and starting at the '?' the keys are separated by a '&' symbol. After each parameter is a sample set of data. The first Key is included as "firstname=test". This means we are passing the Key "firstname" with the value "test". This is referred to as a Key Value Pair. For ever Key there is an associated data you are passing as it's value.
https://client.debtpaypro.com/post/f16b3893c9cf77f6348fa42444979913a6dad41a/?firstname=test&lasname=test&phone=5555555555&state=CA
If given a sample string you will want to separate the Post URL from the Key Value Pairs like below. Having the URL and Keys organized this way will help you when entering the data for the WebHook properly.
https://client.debtpaypro.com/post/f16b3893c9cf77f6348fa42444979913a6dad41a/
firstname=test
lasname=test
phone=5555555555
state=CA
Create a WebHook
Now that we have our posting information we can setup the WebHook. Start by entering a Title, WebHook URL and select the method. If you are unsure of the method select POST to start with. During testing you can switch to GET if the post fails to function correctly with the POST method. If Posting instructions have indicated the need to set the Port and/or Authentication Username and Password you can enter them at this point as well. The Port and Authentication are not required for the WebHook to function. Also, do not mistake the Authentication Username and Password for Key Value Pairs that your posting instructions indicate need to be passed.
*The Authentication refers to Access Authentication which is separate from the actual WebHook's URL and you can use Basic or Digest Types if authentication is required.
Once you have entered information, click "Save WebHook" and move to the next step of adding the Key Value Pairs.
Adding Key Value Pairs
1. Enter the Key in the Field Name input field
We will now be adding the Keys and then mapping data points from the CRM for the value we will be passing. Start by entering the key as provided in the posting instruction or sample string.
*Important: The key must be entered exactly as it exists in the system you are posting to. In our example the instruction provided uses "firstname" as the Key. If "Firstname", "First Name", "fname" or anything straying from the instructed "firstname" is used the post will not work. The Key MUST be entered verbatim to what is provided, no changes to case, spacing or spelling.
2. Now Map the Field from within the CRM to the Key
The next step is to map together the data point from within your CRM to the Key. This enables so that the value saved on a contact for that data will be passed as the value of the key. In our example below we have mapped the system field "First Name" to the Key "firstname". This means when the WebHook runs the value for the system field "First Name" will be passed as the value for the Key "firstname". For example if the contact's first name is saved as "Mike" the Key "firstname" will be passed with the value "Mike". Once you've selected the data point you wish to use, click the green circle icon with the white plus symbol to add it as a Key Value Pair.
*Constant Value - In the case you need to pass a constant value lfor a Key like a API hash or password you can select "Custom Value" for the value and a third input field will appear for you to enter a constant value that will be passed for the Key.
3. Double Check and Confirm
Now that you have added all the Key Value Pairs for the Webhook it is best practice to double check that everything has been inputted correctly. Again if any Keys are spelled incorrectly or differing in anyway from what was provided in the posting instructions or sample string the value will not be passed. The accepting system of the post will not be able to capture the data since it is not looking for a Key that doesn't exist in their system, they won't know what to do with the incorrect Key and usually omit it.
Methods to use WebHooks
1. WebHook Triggers
Location: Linked on WebHook setup page on the left side; "Setup WebHook Triggers"
Similar to eMail Triggers you are able to setup so a system event can trigger the WebHook to run. For example if you use a phone dialer and have a call queue dedicated to calling clients who's payment have been returned. You could setup a WebHook that posts contact information to the call queue in the dialer. Then setup a trigger to use the WebHook in the event a payment has been Returned / NSF.
2. Mass Post
Location: Contacts Tab
Similar to Mass Editing you are able to push a group of leads from the contacts tab. The option will be located in the same drop-down menu as the Mass Edit and Export functions. While viewing the contact tab you will need to select either "With List" (post the entire list you are viewing) or "With Selected" (post only contacts you've selected by checking the box next to their record on the list table). In the example displayed below we have selected "With List" so all 43 contacts will be posted, If we selected "With Selected" we would only be posting the 3 contacts who's boxes we have checked. Once you have made your selections click the green circle icon with a check mark next to the drop-down menu.
Once you clicked the icon you will be taken to the Mass Post page. First select the WebHook you want to post through from the drop-menu displayed. Once you've selected the WebHook a preview of the data you will be posting is displayed. Click "Next Record" to scroll through some of the other records you will be posting to check the data. Once you have confirmed everything is ready click "Post Data". Depending on the number of records you are posting the amount of time it takes for the WebHook to run will vary, once finished you will be taken back to the Contacts Tab.
3. Automatically Post from Data Source
Location: Contacts Tab > Data Source
As part of importing lead via Data Sources you can also have information posted out via a WebHook. You'll find the option to select a WebHook to post through on import at the bottom of the Data Source. Simply highlight the WebHook you wish to use and then save the Data Source. Now the next time a lead is imported through the Data Source it will also post out through the WebHook.
For more information on Data Sources please visit our artcles for setting up an Import or WebForm Data Source
Comments
0 comments
Please sign in to leave a comment.