Subscribe to daily reports

POST

/api/webhooks/complaints/subscribe

INFO

This endpoint is only available to special enterprise clients, schedule a meeting to discuss the pricing

Subscribe to daily spam reports webhook, instead of scraping them yourself

Webhook delivery headers (what you receive):

X-CA-Sub: Subscription UUID (string)
X-CA-Delivery: Delivery UUID (string)
X-CA-Alg: hmac-sha256
X-CA-Ver: 1
X-CA-Sig: sha256=<hex>, where signature = HMAC-SHA256(api_key, X-CA-Delivery)

Signature verification (pseudo):

Webhook payload schema:

[
  {
    "PhoneNumber": "+13058901598",
    "CreatedDate": "2025-10-11T13:04:05Z",
    "ViolationDate": "2025-10-11T12:04:05Z",
    "ConsumerState": "Nebraska",
    "Subject": "Computer & Technical Support",
    "RecordedMessageOrRobocall": "N",
    "Comment": ""
  }
]

Request

Authorization

API Key

Add parameter in header

x-auth

Example:

x-auth: ********************

Body Params application/json

Examples

Responses

🟢200OK

application/json

Body

🟠401Unauthorized

🟠400Bad request

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://callerapi.com/api/webhooks/complaints/subscribe' \
--header 'x-auth: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://partner.example.com/hooks/complaints"
}'

Response Example

200 - Webhook subscription successful

{
    "status": "success"
}

Modified at 2025-10-12 15:29:02

Balance and email

Unsubscribe from daily reports