How to configure webhooks?
Webhooks can be configured under the INTEGRATION menu by clicking the Set up a new integration button.
Payloads
Currently, the Hipcall webhook covers Call, Company, Contact, Task, and Deal. You can find the payloads in the related sections below. Detailed explanations of the fields in the payloads can be found in our article Call Records: Comprehensive Data Guide
Call
Call start
{
"data": {
"hangup_by": null,
"call_flow": [
{
"action": "init",
"detail": {
"id": null,
"type": "contact"
},
"timestamp": 1731840060
}
],
"callee_type": "contact",
"number_id": 328,
"first_touch_duration": null,
"channel_id": 328,
"answered_at": null,
"voicemail_type": null,
"caller_id": null,
"call_duration": null,
"callback_cdr_uuid": null,
"missing_call": null,
"related_id": null,
"callee_number": "+4440333",
"uuid": "2483a75a-56a2-41f1-991b-92b1667e324a",
"callback_time": null,
"related_type": null,
"ended_at": null,
"caller_type": null,
"credited": null,
"channel_type": "number",
"voicemail_url": null,
"callee_id": null,
"user_id": null,
"missing_call_reason": null,
"started_at": "2024-11-17T10:41:00Z",
"bridged_at": null,
"voicemail_id": null,
"contact_id": null,
"callback_user_id": null,
"direction": "outbound",
"caller_number": "+902582440032",
"record_url": null
},
"event": "call_init"
}
Call end
{
"data": {
"hangup_by": "user",
"call_flow": [
{
"action": "hangup",
"detail": {
"hangup_by": "user"
},
"timestamp": 1731840066
},
{
"action": "init",
"detail": {
"id": null,
"type": "contact"
},
"timestamp": 1731840060
}
],
"callee_type": "contact",
"number_id": 328,
"first_touch_duration": 0,
"channel_id": 328,
"answered_at": null,
"voicemail_type": null,
"caller_id": 1121,
"call_duration": 0,
"callback_cdr_uuid": null,
"missing_call": false,
"related_id": null,
"callee_number": "+4440333",
"uuid": "2483a75a-56a2-41f1-991b-92b1667e324a",
"callback_time": null,
"related_type": null,
"ended_at": "2024-11-17T10:41:06Z",
"caller_type": "user",
"credited": false,
"channel_type": "number",
"voicemail_url": null,
"callee_id": null,
"user_id": 1121,
"missing_call_reason": null,
"started_at": "2024-11-17T10:41:00Z",
"bridged_at": null,
"voicemail_id": null,
"contact_id": null,
"callback_user_id": null,
"direction": "outbound",
"caller_number": "+902582440032",
"record_url": null
},
"event": "call_hangup"
}
Task
When a task is created
{
"data": {
"id": 36714,
"name": "Send email to client",
"priority": "medium",
"done": false,
"description": "We need to sent email to client.",
"done_at": null,
"due_date": null,
"assign_to_user_id": 1121
},
"event": "task_create"
}
Deal
When a new deal is created
{
"data": {
"id": 4082,
"name": "Yeni anlaşma",
"state": "waiting",
"amount": 4000,
"lost_at": null,
"won_at": null
},
"event": "deal_create"
}
Next steps
To see real-world use cases of the Hipcall API step by step, check out the other example scenarios:
- : Send call details to your own system with webhooks, store them in your database, and download audio recordings automatically.
- : Detect short calls and automatically assign tags based on who ended the call.
- : Add CRM data to call records so agents can quickly access customer information and open items.