What are webhooks?
A webhook is an automated notification mechanism that delivers real-time HTTP POST requests to your HTTPS endpoint whenever an event occurs in your Hipcall account. Instead of polling the API periodically, call events and CRM updates reach your server within seconds.
How to configure webhooks?
Webhooks are configured under Settings > Developer > Webhooks by clicking the Create (or Add webhook) button.
Setup steps:
- Endpoint: Enter an endpoint name and your public HTTPS URL (for example:
https://your-server.example.com/hipcall/events). Hipcall does not send to plain HTTP and does not follow redirects. - Events: Select the event types to subscribe to (
call.initiated,call.connected,call.ended,task.created,deal.created, etc.). - Recording links: Enable this option if you want call events to carry temporary 7-day listening links (
record_urlandvoicemail_url). This requires permission to view communication content. - Signing secret: After creating the webhook, open the Signing secret tab and copy the secret starting with
whsec_into an environment variable.
Hipcall Webhook v2 follows the open-source Standard Webhooks specification. Every request sent to your receiver includes these headers:
webhook-id: Unique event ID (evt_...). It stays the same across retries.webhook-timestamp: Unix timestamp in seconds for when the delivery was sent.webhook-signature:v1,followed by a base64 HMAC-SHA256 signature.
Verifying the signature ensures that the request originated from Hipcall and was not altered in transit.
Payloads
Currently, the Hipcall webhook covers Call, Company, Contact, Task, and Deal. Event payloads follow the Standard Webhooks structure, with id, type, timestamp, and data at the top level. You can find detailed explanations of the fields in our article Call Records: Comprehensive Data Guide.
Call
Call start
When a call starts, Hipcall sends a call.initiated event:
{
"id": "evt_2nb7kq4xyc8vfr1tlm0pzab3cd",
"type": "call.initiated",
"timestamp": "2026-10-22T08:26:59Z",
"data": {
"uuid": "9a266251-d2a3-44fc-b422-9486ddf880c7",
"direction": "outbound",
"caller_number": "+442079XXXXXX",
"callee_number": "+447700XXXXXX",
"caller_id": null,
"caller_type": null,
"callee_id": null,
"callee_type": "contact",
"contact_id": null,
"deal_id": null,
"company_id": null,
"user_id": 101,
"number_id": 10,
"channel_id": 10,
"channel_type": "number",
"started_at": "2026-10-22T08:26:59Z",
"answered_at": null,
"bridged_at": null,
"ended_at": null,
"call_duration": null,
"first_touch_duration": null,
"team_touch_at": null,
"credited": null,
"hangup_by": null,
"missing_call": null,
"missing_call_reason": null,
"callback_time": null,
"callback_user_id": null,
"callback_cdr_uuid": null,
"voicemail_id": null,
"voicemail_type": null,
"voicemail_url": null,
"has_recording": false,
"record_url": null,
"call_flow": [
{
"action": "init",
"detail": {
"id": null,
"type": "contact"
},
"timestamp": 1792657619
}
]
}
}
Call end
When a call ends, Hipcall sends a call.ended event with duration details, hangup party, and recording link:
{
"id": "evt_4nb9kq6xyc0vfr3tlm2pzab5ef",
"type": "call.ended",
"timestamp": "2026-10-22T08:27:19Z",
"data": {
"uuid": "9a266251-d2a3-44fc-b422-9486ddf880c7",
"direction": "outbound",
"caller_number": "+442079XXXXXX",
"callee_number": "+447700XXXXXX",
"caller_id": 101,
"caller_type": "user",
"callee_id": null,
"callee_type": "contact",
"contact_id": null,
"deal_id": null,
"company_id": null,
"user_id": 101,
"number_id": 10,
"channel_id": 10,
"channel_type": "number",
"started_at": "2026-10-22T08:26:59Z",
"answered_at": "2026-10-22T08:27:06Z",
"bridged_at": "2026-10-22T08:27:06Z",
"ended_at": "2026-10-22T08:27:19Z",
"call_duration": 20,
"first_touch_duration": 7,
"team_touch_at": null,
"credited": false,
"hangup_by": "user",
"missing_call": false,
"missing_call_reason": null,
"callback_time": null,
"callback_user_id": null,
"callback_cdr_uuid": null,
"voicemail_id": null,
"voicemail_type": null,
"voicemail_url": null,
"has_recording": true,
"record_url": "https://storage.hipcall.com/recordings/...&X-Amz-Expires=604800&X-Amz-Signature=...",
"call_flow": [
{
"action": "hangup",
"detail": {
"hangup_by": "user"
},
"timestamp": 1792657639
},
{
"action": "bridge",
"detail": {
"id": 101,
"type": "user"
},
"timestamp": 1792657620
},
{
"action": "init",
"detail": {
"id": null,
"type": "contact"
},
"timestamp": 1792657619
}
]
}
}
Task
When a task is created
When a new task is created in your account, Hipcall fires a task.created event:
{
"id": "evt_5nb0kq7xyc1vfr4tlm3pzab6fg",
"type": "task.created",
"timestamp": "2026-10-22T08:30:00Z",
"data": {
"id": 105,
"name": "Send email to client",
"priority": "medium",
"done": false,
"description": "We need to send email to client.",
"done_at": null,
"due_date": null,
"assign_to_user_id": 101
}
}
Deal
When a new deal is created
When a new deal is created in your account, Hipcall fires a deal.created event:
{
"id": "evt_6nb1kq8xyc2vfr5tlm4pzab7gh",
"type": "deal.created",
"timestamp": "2026-10-22T08:35:00Z",
"data": {
"id": 201,
"name": "New deal",
"state": "waiting",
"amount": 4000,
"lost_at": null,
"won_at": null
}
}
Next steps
To see real-world use cases of the Hipcall API step by step, check out the other example scenarios:
- Transfer Call Details and Voice Recordings to Your Own System Using Webhooks.: Send call details to your own system with webhooks, store them in your database, and download audio recordings automatically.
- Automatically Tagging Short Calls via Hipcall API : Detect short calls and automatically assign tags based on who ended the call.
- Automatically Adding Caller Summaries to Every Call Record : Add CRM data to call records so agents can quickly access customer information and open items.