Webhooks are endpoints that you can create in Ringba that will allow you to send data back to our system for triggering offline conversions, performance based routing, enhanced reporting and further insight into your call flows.

After generating a Webhook, you will have a URL you can use to pass data back to Ringba using the Inbound ID assigned to every call routed through our system. There are a few ways for you to get the Inbound ID:

Using SIP we add a Call Token to every call routed to a SIP target. Ringba passes a unique token in every SIP header, this ID is then captured by the target's system.
You can fire a Pixel on an incoming call to your CRM or any other system that contains the Inbound ID as part of the URL parameters, this can be a GET or a POST.

Once the receiving system has captured the ID it can be used in the Ringba webhook URL to pass revenue data into Ringba.

Create a Webhook
To create a Ringba Webhook:

Navigate to "Webhooks" under 'Integrations' from the main menu.
Click "Create Webhook".
Configure Webhook options: Name, Call Token, Revenue Token and Fire Conversions.
Click "Add" to create and save the Webhook.
After creating it you should see it on the list of webhooks along with the URL that must be used to trigger the conversion if your target is converting on Webhook. It look like this: https://webhook.ringba.com/hook/<WebhookID>?call_id=[callUUID]&call_revenue=[conversionAmount]&sale_sucesful=yes

Required Fields and Options when Configuring a Webhook

Name - This is the name that will be used to describe your webhook information on the report.
Call Token - This is the name of the parameter that Ringba will collect the Inbound Id from, we use this ID to uniquely identify which call the requests apply to.
Revenue Token - Name of the parameter that Ringba will collect the revenue from.
Fire Conversion - If the optional string is set and the incoming request has it on the parameters then Ringba will set the call as converted and add revenue to the call.



Using the Webhook as a Conversion Event

When setting the target in your campaign’s routing plan, set the “Convert On” field as “Postback/Webhook” as in the following image:



You can test it by getting a call without sending a request to the webhook. You can see the example call below before this action.



After making the GET request to the webhook we should see the same field plus the extra information that belongs to the webhook conversion.




Webhooks FAQs and Troubleshooting

What should I do if I need help with Webhooks?
If you have any questions or need additional help, please reach out to our support team via chat or email at support@ringba.com.