Create a webhook subscription - Dialbird API

Error

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "event_type": "message.incoming.received",
  "target_url": "<string>",
  "signing_secret": "whsec_8f3c…",
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "validation_error",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>"
  }
}

POST

/

subscriptions

Error

A valid request URL is required to generate request examples

{
  "id": "<string>",
  "event_type": "message.incoming.received",
  "target_url": "<string>",
  "signing_secret": "whsec_8f3c…",
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "code": "validation_error",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "validation_error",
    "message": "<string>",
    "request_id": "<string>",
    "field": "<string>"
  }
}

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

event_type

enum<string>

required

Available options:

message.incoming.received,

message.outgoing.delivered,

call.incoming.completed,

call.outgoing.completed

target_url

string<uri>

required

HTTPS URL that receives event deliveries.

Example:

"https://hooks.zapier.com/hooks/standard/123/abc/"

Response

Subscription created.

id

string

event_type

enum<string>

Available options:

message.incoming.received,

message.outgoing.delivered,

call.incoming.completed,

call.outgoing.completed

target_url

string<uri>

signing_secret

string

Returned only at creation. Prefixed whsec_.

Example:

"whsec_8f3c…"

status

enum<string>

failing after consecutive delivery failures cross the warning threshold; disabled after they cross the hard limit or the receiver returns 410 Gone.

Available options:

active,

failing,

disabled

created_at

string<date-time>