aircall-webhooks
Receive and verify Aircall webhooks. Use when setting up Aircall webhook handlers, debugging Aircall webhook token verification, or handling Aircall cloud phone events like call.created, call.answered, call.ended, message.received, contact.updated, or user.connected.v2. Aircall does NOT use an HMAC signature — verification is a timing-safe comparison of the `token` field inside the JSON body.
hookdeck · 已有 AI 审核记录
安装与使用
运行命令前先阅读来源与依赖说明。复制命令不会自动安装或执行。
npx skills add hookdeck/webhook-skills --skill aircall-webhooks技能说明
name: aircall-webhooks
description: >
Receive and verify Aircall webhooks. Use when setting up Aircall webhook
handlers, debugging Aircall webhook token verification, or handling Aircall
cloud phone events like call.created, call.answered, call.ended,
message.received, contact.updated, or user.connected.v2. Aircall does NOT use
an HMAC signature — verification is a timing-safe comparison of the token
field inside the JSON body.
license: MIT
metadata:
author: hookdeck
version: "0.1.0"
repository: https://github.com/hookdeck/webhook-skills
Aircall Webhooks
Aircall is a cloud call-center / business phone system. Its webhooks push call, user, number, contact, messaging, and conversation-intelligence events to your endpoint.
When to Use This Skill
- How do I receive Aircall webhooks?
- How do I verify Aircall webhooks? (there is no signature header — see below)
- Why is my Aircall webhook verification failing?
- How do I handle
call.created,call.answered, orcall.endedevents? - How do I get my Aircall webhook token?
- Why did Aircall disable my webhook?
Verification: Token in the Body, NOT an HMAC Signature
Aircall has no signature header and no cryptographic signature. Every event body
contains a top-level token string equal to the token issued when the webhook was
created. Verify by comparing that field against your stored token.
Do not look for X-Aircall-Signature, HMAC-SHA256, or Standard Webhooks headers — none
exist. Third-party blog posts that describe an Aircall HMAC header are wrong. (Aircall's
own docs loosely say "verify webhook signatures" in a code comment, but the mechanism is
a plain shared-secret comparison.)
Verification (core)
const crypto = require('crypto');
// Aircall sends its shared secret verbatim as `token` in the JSON body.
// Compare in constant time so the token can't be recovered by timing.
function verifyAircallWebhook(payloadToken, expectedToken) {
if (typeof payloadToken !== 'string' || !expectedToken) return false;
try {
return crypto.timingSafeEqual(
Buffer.from(payloadToken),
Buffer.from(expectedToken)
);
} catch {
return false; // different lengths -> invalid
}
}
// Usage: const { resource, event, timestamp, token, data } = req.body;
// if (!verifyAircallWebhook(token, process.env.AIRCALL_WEBHOOK_TOKEN)) -> 401
import secrets
def verify_aircall_webhook(payload_token: str | None, expected_token: str | None) -> bool:
if not payload_token or not expected_token:
return False
return secrets.compare_digest(payload_token, expected_token)
Because the secret is in the body, you do not need the raw body — parsed JSON is fine here. (Raw body only matters for HMAC providers.) The token travels in cleartext, so HTTPS is mandatory.
For complete handlers with tests, see examples/express/, examples/nextjs/, examples/fastapi/.
Payload Envelope
Every event has exactly five top-level fields:
| Field | Type | Description |
|---|---|---|
resource | String | Resource for this event — call, user, number, contact, message, integration, conversation_intelligence, ai_voice_agent, analytics |
event | String | Event name, e.g. call.answered |
timestamp | Integer | UNIX timestamp (UTC) for when the payload was built |
token | String | Webhook token — use this to verify |
data | Object | The resource at timestamp |
{
"resource": "number",
"event": "number.closed",
"timestamp": 1585001020,
"token": "45XXYYZZa08",
"data": {
"id": 456,
"direct_link": "https://api.aircall.io/v1/numbers/123",
"name": "My first Aircall Number",
"digits": "+33 1 76 36 06 95",
"country": "FR",
"time_zone": "Europe/Paris",
"open": false,
"users": [{ "id": 456, "name": "Madelaine Dupont", "available": false }]
}
}
timestamp is unsigned metadata. Do not use it as a replay/staleness control —
Aircall has no replay protection, so a tolerance check would only cause false rejections.
Common Event Types
| Event | Triggered When | Common Use Cases |
|---|---|---|
call.created | Inbound call hits a number, or an agent starts an outbound call | Screen-pop, CRM lookup |
call.ringing_on_agent | Call rings on a specific agent | Agent-level routing analytics |
call.answered | An agent answers | Start call timer, log connect |
call.hungup | Either party hangs up | Detect abandoned calls |
call.ended | Call fully ended, assets finalized | Write call record, duration, cost |
call.tagged / call.untagged | A tag is added/removed | Disposition reporting |
call.voicemail_left | Caller leaves a voicemail | Voicemail follow-up queue |
message.received | Inbound SMS/MMS/WhatsApp | Conversational inbox |
message.status_updated | Outbound message status changes | Delivery tracking |
contact.created / contact.updated | Contact changes | CRM sync |
user.connected.v2 / user.disconnected.v2 | Agent opens/closes Workspace | Presence dashboards |
number.opened / number.closed | Number enters/leaves business hours | Routing rules |
transcription.created / summary.created | AI artifacts ready (AI Assist add-on) | Conversation intelligence |
Full catalog (all 67 events, including User V1 vs V2 and AI Voice Agent): references/overview.md
Use User V2 events (user.created.v2, …). V1 events are deprecated — Aircall's docs
say "This version of User events V1 will be deprecated soon. Please migrate to User
events V2."
Delivery Semantics (Design Your Handler Around These)
- Respond 200 immediately — Aircall times out after 5 seconds. Process async.
- At least once, unordered — "an event will be delivered at least once, if generated, but events might