Create a new webhook

Creates a versioned webhook through the unified endpoint when using the API version header.

POST /webhooks

Create a new webhook

cURL

curl --request POST \
  --url https://dev-public-api.openphone.dev/webhooks \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Quo-Api-Version: <quo-api-version>' \
  --data '
{
  "events": [
    "call.completed"
  ],
  "url": "https://example.com/webhook",
  "resourceIds": [
    "PNabc123"
  ],
  "status": "enabled",
  "label": "my webhook"
}
'

201

{
  "data": {
    "id": "123",
    "orgId": "OR1223abc",
    "label": "my webhook label",
    "status": "enabled",
    "url": "https://example.com/",
    "createdAt": "2022-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "events": [
      "call.completed"
    ],
    "resourceIds": [
      "PNabc123"
    ],
    "key": "whsec_exampleSecret",
    "apiVersion": "2026-03-30"
  }
}

{
  "message": "/url: Expected required property, /url: Expected string",
  "docs": "https://quo.com/docs",
  "title": "Bad Request",
  "errors": [
    {
      "path": "/url",
      "message": "Expected required property",
      "schema": {
        "type": "String"
      }
    },
    {
      "path": "/url",
      "message": "Expected string",
      "schema": {
        "type": "String"
      }
    }
  ]
}

{
  "message": "You are unauthorized to access the webhook",
  "docs": "https://quo.com/docs",
  "title": "Unauthorized"
}

{
  "message": "You are forbidden to access the webhook",
  "docs": "https://quo.com/docs",
  "title": "Forbidden"
}

{
  "message": "An unknown error occurred",
  "docs": "https://quo.com/docs",
  "title": "Unknown Error"
}

Authorizations

Authorization · string · header · required

Headers

Quo-Api-Version · enum<string> · required

API version header. Supported values: 2026-03-30

Available options: 2026-03-30

Body

application/json

events · enum<string>[] · required

Minimum array length: 1

Event type

Available options: call.answered, call.completed, call.forwarded, call.menu.selected, call.missed, call.ringing, call.recording.completed, call.summary.completed, call.transcript.completed, call.voicemail.completed, message.received, message.delivered, message.failed, message.undelivered, contact.updated, contact.deleted, task.assigned, task.created, task.completed, task.updated, task.deleted, task.unassigned, task.reopened, task.duedate.removed, task.duedate.updated, task.overdue, task.linked, task.unlinked

url · string<uri> · required

The endpoint that receives events from the webhook.

Example:

"https://example.com/webhook"

resourceIds · Option 1 · string[] Option 2 · string[]

Phone number IDs to filter activity events, or ["*"] for all. Omitting this field defaults to ["*"]. Contact events are always org-wide regardless of this setting.

Minimum array length: 1

Pattern: ^PN(.*)$

Example:

["PNabc123"]

status · enum<string> · default: enabled

The status of the webhook.

Available options: enabled, disabled

Example:

"enabled"

label · string

The webhook's label.

Example:

"my webhook"

Response

201

application/json

Created

data · object · required

Show child attributes