Webhooks is a way for an app to provide other applications with real-time information. It allows delivering data to other applications as it happens, which means you get data immediately.
Webhooks method lets you integrate Ringostat with the other services and applications. You can create up to 40 webhooks for each event on each installation target.
Step 1: Create a new Webhook
Enter a name for the new Webhook and add the following details:
URL — a web address of the source you will send the requests to. It can be HTTP or HTTPS, either.
Time request was sent — is an event, which is a signal to send Webhook.
HTTP request method — select the method according to the documentation of the system you are integrating with.
Request method — select the method according to the documentation of the system you are integrating with.
Date format — set the required date format
You can use a few types of this request:
Prior to call — allows sending the call details like a key phrase or advertising source right after the call.
After call — allows sending all call details, including a call record, duration, region, etc.
After call rating menu — allows sending a category name and value, a call agent’s ID.
When taking the call — it lets send a call data for a notification to the responsible call agent.
Forward location — it lets send the details of a call forwarding location you redirect the calls to.
Before outgoing call — it lets send the data before the outgoing call to the system.
After outgoing call — it lets send the data after the outgoing call to the system.
HTTP request method
Before choosing the HTTP request method, check the system documentation you will integrate Ringostat with.
You can use such methods as:
GET
POST
PUT
DELETE
Request method
First, check what method your system accepts and select it. There are a few types you can use:
Http;
JSON;
XML;
JSON-RCP.
Step 2: Set the parameters you are going to send
After creating the Webhook with the main parameters you need, click on “Configure” next to created Webhook and configure the required parameters.
Here you should enter the Parameter name and select its value.
You can get the name of the needed parameter from the documentation of the system you will integrate with Ringostat. The name of the parameter should be added to the URL parameter too.
Recommendation: If you don’t know which parameter you need or have any doubts, better ask the support team.
Please note: such parameters like Visitor UUID can be sent only if you use session-based call tracking by DNI (Dynamic numbers insertion).