Skip to content
Talki DevelopersBeta

caller_rule.created

POST

A VIP or blocked number is added. Sent to the account’s webhooks, and to an OAuth app that subscribes to it while its installation grants contacts:read.

Parameters

Section titled “ Parameters ”

Header Parameters

Section titled “Header Parameters”
X-Talki-Signature
required
string

t=<unix seconds>,v1=<hex HMAC-SHA256>, the HMAC computed over <t>.<raw body> with the signing secret. During a secret rotation it carries one v1 per secret: accept the request if any matches.

X-Talki-Event
required
string

The event type, as in type.

X-Talki-Delivery
required
string

The event ID, as in id.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
id
required
Id

The event’s ID, evt_ and 32 hex characters. Equal to the X-Talki-Delivery header and unchanged on a redelivery: deduplicate on it.

string
type
required
string
Allowed values: caller_rule.created
created_at
required
Created At

When the event was written, ISO 8601 with a +00:00 offset, possibly with microseconds. Parse it as an instant.

string format: date-time
api_version
required
Api Version

The dated contract version data is shaped for: the endpoint’s version on a webhook, the app’s on an app event.

string
account_id
required
Account Id

The Talki account the event happened on.

string
livemode
required
Livemode

false for an event from a sandbox account.

boolean
origin
required
Any of:
EventOrigin
object
source
required
Source

Where the change came from: voice (the assistant, during a call), dashboard (a person in the Talki web or mobile app), api (a credential through the API) or system (a rule Talki applied on its own). New values may be added; treat one you do not recognise as unknown.

string
credential_id
required
Any of:
string
idempotency_key
required
Any of:
string
installation_id
Any of:
string
data
required

The event’s payload.

object
object
required

The CallerRule object, as the REST API returns it.

object
id
required
Id

Rule identifier.

string
location_id
required
Location Id

The location whose calls it matches (GET /v1/locations). Never null, and it never changes.

string
phone_number
required
Phone Number

The number, E.164.

string
kind
required

vip or blocked.

string
Allowed values: vip blocked
label
required
Any of:
string
created_at
required
Created At

RFC 3339 UTC.

string format: date-time
updated_at
required
Updated At

RFC 3339 UTC.

string format: date-time
Example
{
  "id": "evt_04d8e87897db4ecab459a456ea55e754",
  "type": "caller_rule.created",
  "created_at": "2026-09-22T15:04:06.218734+00:00",
  "api_version": "2026-10-01",
  "account_id": "f7e39b9a-1ac8-45e4-93da-2600f17cb286",
  "livemode": true,
  "origin": {
    "source": "dashboard",
    "credential_id": null,
    "idempotency_key": null
  },
  "data": {
    "object": {
      "id": "93c7e0a5-2d1f-4b68-8e4a-c6f19b2d7e30",
      "phone_number": "+393401234567",
      "location_id": "0b7d4e19-8a2c-4f61-9d3e-5c1a7b2f8e40",
      "kind": "blocked",
      "label": "Telemarketing",
      "created_at": "2026-10-02T09:10:00Z",
      "updated_at": "2026-10-02T09:10:00Z"
    }
  }
}

Responses

Section titled “ Responses ”

2XX

Section titled “2XX”

Any 2xx acknowledges the event. Any other status, a redirect, or no answer within 10 seconds is a failure and is retried; 410 disables a webhook endpoint at once.