Update a webhook by ID

Partially update an existing webhook. Only the fields provided in the request body will be updated.

PATCH /webhooks/{webhookId}

Update a webhook by ID

cURL

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

200

{
  "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": [
      "message.received"
    ],
    "resourceIds": [
      "PN1234"
    ],
    "apiVersion": "2026-03-30"
  }
}

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

Path Parameters

webhookId · string · required

The unique identifier of a webhook

Pattern: ^[0-9]+$

Example:

"123"

Body

application/json

url · string<uri>

The endpoint that receives events from the webhook.

Example:

"https://example.com/"

events · enum<string>[]

An event associated with the webhook.

Minimum array length: 1

Event type

Available options: message.received, message.delivered, message.failed, message.undelivered, call.ringing, call.answered, call.completed, call.missed, call.forwarded, call.menu.selected, call.recording.completed, call.transcript.completed, call.summary.completed, call.voicemail.completed, contact.updated, contact.deleted, integration.created, integration.updated, integration.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

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

The unique identifiers of the phone numbers associated with the webhook. Pass null, [], or ["*"] to clear phone number filtering.

Pattern: ^PN(.*)$

Example:

["PN1234"]

status · enum<string>

The status of the webhook.

Available options: enabled, disabled

Example:

"enabled"

label · string | null

Webhook's label

Response

200

application/json

OK

data · object · required

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Show child attributes