Create webhook subscription
curl --request POST \
--url https://api.aura-app.ai/v1/webhooks \
--header 'Content-Type: application/json' \
--data '
{
"event_type": "call.booked",
"target_url": "https://api.example.com/webhooks/aura"
}
'import requests
url = "https://api.aura-app.ai/v1/webhooks"
payload = {
"event_type": "call.booked",
"target_url": "https://api.example.com/webhooks/aura"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({event_type: 'call.booked', target_url: 'https://api.example.com/webhooks/aura'})
};
fetch('https://api.aura-app.ai/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aura-app.ai/v1/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'event_type' => 'call.booked',
'target_url' => 'https://api.example.com/webhooks/aura'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aura-app.ai/v1/webhooks"
payload := strings.NewReader("{\n \"event_type\": \"call.booked\",\n \"target_url\": \"https://api.example.com/webhooks/aura\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aura-app.ai/v1/webhooks")
.header("Content-Type", "application/json")
.body("{\n \"event_type\": \"call.booked\",\n \"target_url\": \"https://api.example.com/webhooks/aura\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aura-app.ai/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"event_type\": \"call.booked\",\n \"target_url\": \"https://api.example.com/webhooks/aura\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"created_at": "2026-01-17T08:00:00Z",
"event_type": "call.booked",
"id": "550e8400-e29b-41d4-a716-446655440000",
"target_url": "https://api.example.com/webhooks/aura",
"secret": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"event_types": [
"call.booked",
"call.completed"
]
},
"success": true
}{
"error": "Webhook subscription not found",
"success": false,
"code": "WEBHOOK_NOT_FOUND"
}{
"error": "Webhook subscription not found",
"success": false,
"code": "WEBHOOK_NOT_FOUND"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}Webhooks
Create webhook subscription
Subscribe to real-time events from Aura.
How it works:
- Create a subscription with your endpoint URL
- Store the
secretfrom this response — it is returned only here, never byGET /v1/webhooksorGET /v1/webhooks/{id}. If you lose it, rotate it withPOST /v1/webhooks/{id}/rotate-secret. - When events occur, Aura sends HTTP POST requests to your URL
- Verify requests using the
X-Aura-Signatureheader
Security:
- Target URL must use HTTPS (no HTTP allowed)
- Each webhook is signed with HMAC-SHA256
- Use the secret to verify request authenticity
Payload Format:
{
"event": "call.booked",
"created_at": "2026-01-17T08:00:00Z",
"data": { /* event-specific data */ },
"organization_id": "org_xxx",
"idempotency_key": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
Signature Verification:
const crypto = require('crypto');
const signature = crypto
.createHmac('sha256', YOUR_SECRET)
.update(JSON.stringify(payload))
.digest('hex');
Retry Policy:
- Failed deliveries are retried 3 times
- Backoff: 1s, 5s, 15s
- Subscriptions with repeated failures may be disabled
Exactly-once processing (idempotency_key):
- Every envelope carries an
idempotency_keythat is stable across retries of the same event. If your endpoint commits its side effect then crashes before returning 2xx, the redelivery carries the same key. - Enforce exactly-once by adding a
(subscription_id, idempotency_key)unique constraint on your side and dropping the row on conflict. - The key is inside the signed body, so the HMAC signature covers it.
POST
/
v1
/
webhooks
Create webhook subscription
curl --request POST \
--url https://api.aura-app.ai/v1/webhooks \
--header 'Content-Type: application/json' \
--data '
{
"event_type": "call.booked",
"target_url": "https://api.example.com/webhooks/aura"
}
'import requests
url = "https://api.aura-app.ai/v1/webhooks"
payload = {
"event_type": "call.booked",
"target_url": "https://api.example.com/webhooks/aura"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({event_type: 'call.booked', target_url: 'https://api.example.com/webhooks/aura'})
};
fetch('https://api.aura-app.ai/v1/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.aura-app.ai/v1/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'event_type' => 'call.booked',
'target_url' => 'https://api.example.com/webhooks/aura'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.aura-app.ai/v1/webhooks"
payload := strings.NewReader("{\n \"event_type\": \"call.booked\",\n \"target_url\": \"https://api.example.com/webhooks/aura\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.aura-app.ai/v1/webhooks")
.header("Content-Type", "application/json")
.body("{\n \"event_type\": \"call.booked\",\n \"target_url\": \"https://api.example.com/webhooks/aura\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.aura-app.ai/v1/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"event_type\": \"call.booked\",\n \"target_url\": \"https://api.example.com/webhooks/aura\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"created_at": "2026-01-17T08:00:00Z",
"event_type": "call.booked",
"id": "550e8400-e29b-41d4-a716-446655440000",
"target_url": "https://api.example.com/webhooks/aura",
"secret": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
"event_types": [
"call.booked",
"call.completed"
]
},
"success": true
}{
"error": "Webhook subscription not found",
"success": false,
"code": "WEBHOOK_NOT_FOUND"
}{
"error": "Webhook subscription not found",
"success": false,
"code": "WEBHOOK_NOT_FOUND"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}{
"code": "<string>",
"error": "<string>",
"success": false,
"requestId": "<string>"
}Subscribe to real-time events from Aura.
How it works:
Signature Verification:
Retry Policy:
- Create a subscription with your endpoint URL
- Store the
secretfrom this response — it is returned only here, never byGET /v1/webhooksorGET /v1/webhooks/{id}. If you lose it, rotate it withPOST /v1/webhooks/{id}/rotate-secret. - When events occur, Aura sends HTTP POST requests to your URL
- Verify requests using the
X-Aura-Signatureheader
- Target URL must use HTTPS (no HTTP allowed)
- Each webhook is signed with HMAC-SHA256
- Use the secret to verify request authenticity
{
"event": "call.booked",
"created_at": "2026-01-17T08:00:00Z",
"data": { /* event-specific data */ },
"organization_id": "org_xxx",
"idempotency_key": "f47ac10b-58cc-4372-a567-0e02b2c3d479"
}
const crypto = require('crypto');
const signature = crypto
.createHmac('sha256', YOUR_SECRET)
.update(JSON.stringify(payload))
.digest('hex');
- Failed deliveries are retried 3 times
- Backoff: 1s, 5s, 15s
- Subscriptions with repeated failures may be disabled
idempotency_key):
- Every envelope carries an
idempotency_keythat is stable across retries of the same event. If your endpoint commits its side effect then crashes before returning 2xx, the redelivery carries the same key. - Enforce exactly-once by adding a
(subscription_id, idempotency_key)unique constraint on your side and dropping the row on conflict. - The key is inside the signed body, so the HMAC signature covers it.
Body
application/json
Event type to subscribe to
Available options:
lead.created, lead.updated, lead.status_changed, call.booked, call.updated, call.started, call.completed, call.canceled, call.rescheduled, call.closer_reassigned, call.no_show, call.analysis_completed, payment.succeeded, payment.failed, payment.refunded Example:
"call.booked"
HTTPS URL where webhook payloads will be sent (must be publicly accessible)
Example:
"https://api.example.com/webhooks/aura"