Save the webhook URL

PUT

/api/did-monitoring/v1/webhook

Saves the URL that receives webhook events. An account has one webhook URL. A new save replaces the old URL.

The URL must use https on port 443 or 8443. The host must resolve to a public address. CallerAPI does not accept private, loopback, or link-local addresses. CallerAPI does not follow redirects. The maximum length is 2,048 characters. CallerAPI checks these rules when you save and again before each delivery.

The first save returns secret. Keep it in a safe place. CallerAPI shows it one time only. A later save keeps the same secret and does not return it.

If CallerAPI turned off the webhook after delivery failures, a save turns it on again.

INFO

Webhooks are not available on the Free plan.

Request

Authorization

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Bodyapplication/json

🟠400Bad request

🟠401Unauthorized

🟠403Requires upgrade

🟠429Too many requests

🔴503Service unavailable

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.callerapi.com/api/did-monitoring/v1/webhook' \
--header 'Content-Type: application/json' \
--data '{
    "url": "https://hooks.example.com/callerapi"
}'

Response Example

200 - First save, with the secret

{
    "status": "success",
    "data": {
        "url": "https://hooks.example.com/callerapi",
        "active": true,
        "secret": "whsec_REPLACE_WITH_YOUR_SECRET"
    }
}

Modified at 2026-10-29 10:41:34

Set the check schedule

Read the webhook