Opportunity Webhook
How to pass Opportunity Stage changes into Ruler Analytics using Webhooks
Send your opportunities to Ruler as they move through the various CRM stages using the opportunity Webhook.
When to use this webhook
Use the Opportunity Webhook when you want to pass back deals from your CRM that may not necessarily be won deals with a Revenue value yet. This is suited to users who may have a long lead cycle before a lead is converted to a closed deal.
https://public-api.rulerapi.com/api/1/opportunity
{
"Content-type": "application/json",
"X-Authorization": "VnPQsFMJDfLkaKdDJWloaNVBs7Z4XEbFgakjHJfEBPV1zPYxdxt1208"
}
X-Authorization should be the API Key from your Ruler Analytics dashboard. https://app.ruleranalytics.com/#/site-setup
Post Variables | |
---|---|
email (required if phone is not present) | The Customer's Email you wish to post |
phone (required if email is not present) | The Customer's phone number you wish to post |
label | This is a custom label for the deal |
stage (required) | This should map to the stage names you have configured in Ruler Analytics |
value (required) | Any value can be given here. If there is no value 0, alternatively you can put a forecast revenue value |
date (required) | The date of the stage change |
key (required) | Your API key from Ruler Analytics |
See below an example webhook request with the necessary parameters populated.
{
"email": "[email protected]",
"value": "1.00",
"date": "2018-01-01T00:00:00",
"label": "Wills and Probate Enquiry",
"stage": "Opportunity",
"key": xhayhshushduhs-456dnsjhkjdsjb"
}
Example of a successful fire
HTTP/1.1 200 OK
Below is an example of a potential error which would indicate your post was not successfully sent to Ruler Analytics.
HTTP/1.1 503 Invalid Visitor Id
To ensure the webhook has fired successfully review your Opportunity tab in the Dashboard.
Updated almost 3 years ago