A webhook is a way to notify third-party applications about Ringostat events by sending a set of parameters. To learn how to create a webhook in Ringostat, please refer to this article.
Call categories are used to classify calls based on specific characteristics — for example: sale, location inquiry, clarification on an existing order, non-target call, and so on. Categories for a call can be set in the Details → Comments and Categories section of the Call card
When a call category is set, the following parameters can be sent via webhook:
Call category name — a list of all categories added to the call.
Call ID — the unique identifier of the call in Ringostat.
Project ID — the unique identifier of your project.
The full list of parameters is available here.
Creating a webhook request
To create a new webhook request, go to Integration → Webhooks in your dashboard
Click Add Event
A settings panel for the handler will open
Fill in the fields for the new event:
Name — enter a name for the event (for example, Call Category Set).
Event — select the event from the list
Then configure the webhook request parameters:
Data sending method — GET, POST, or PUT.
Destination — the handler URL where the request will be sent.
Headers — add any required headers. Content-Type headers are set automatically.
Data format — the format in which data will be sent to the handler.
Date format — set to Standard date by default.
Request body — select the required parameters from the available list
Example of processed parameters in JSON format:
{
"category_name": ["Consultation on a new order"],
"call_id": "3333333333.3333333"
}