Skip to main content
WEBHOOK
message.incoming.received
{
  "id": "evt_4f9a2c…",
  "api_version": "<string>",
  "occurred_at": "2023-11-07T05:31:56Z",
  "business_id": "<string>",
  "data": {
    "message": {
      "id": "<string>",
      "body": "<string>",
      "from_number": "<string>",
      "to_number": "<string>",
      "media_urls": [
        "<string>"
      ],
      "created_at": "2023-11-07T05:31:56Z"
    },
    "conversation": {
      "id": "<string>"
    },
    "contact": {
      "id": "<string>",
      "name": "<string>",
      "phone_number": "<string>"
    },
    "user": {
      "id": "<string>",
      "name": "<string>"
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.dialbird.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authorization Code flow against Dialbird's OIDC provider. The issued access token is a JWT with aud: "public-api", verified against the issuer JWKS.

Body

application/json

Webhook delivery body. Signed with X-Dialbird-Signature (t=<unix>,v1=<hmac_sha256_hex> over ${t}.${raw_body}). Also carries X-Dialbird-Event-Id and X-Dialbird-Event-Type headers.

​
id
string
required

Globally unique event id, prefixed evt_. Use as a dedup key.

Example:

"evt_4f9a2c…"

​
type
enum<string>
required
Available options:
message.incoming.received,
message.outgoing.delivered,
call.incoming.completed,
call.outgoing.completed
​
api_version
string
required
Allowed value: "v1"
​
occurred_at
string<date-time>
required

When the event occurred (not when delivered).

​
business_id
string
required
​
data
object
required

Response

200

Acknowledge receipt with any 2xx. A 410 disables the subscription.