Send a test event to a webhook

Dispatches a canonical sample payload of the specified event type to the webhook URL so you can validate your endpoint before going live. The response returns the rendered sample payload so you can preview the body your endpoint will receive. Delivery to your URL is processed asynchronously; use the delivery detail endpoint to inspect the attempt.

POST /webhooks/{webhookId}/events/test

Send a test event to a webhook

cURL

curl --request POST \
  --url https://dev-public-api.openphone.dev/webhooks/{webhookId}/events/test \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'Quo-Api-Version: <quo-api-version>' \
  --data '
{
  "eventType": "call.completed"
}
'

200

{
  "id": "msg_2abcDEFghiJKLmnoPQRstu",
  "apiVersion": "2026-03-30",
  "type": "call.completed",
  "createdAt": "2023-11-07T05:31:56Z",
  "data": {
    "context": {
      "contacts": {
        "ids": [
          "CTsampleContact01234"
        ],
        "lookupStatus": "matched"
      },
      "conversationId": "CNsampleconversation000000000000",
      "participants": {
        "external": [
          "[phone]"
        ],
        "resolution": "available",
        "workspace": [
          "[phone]"
        ]
      },
      "phoneNumberId": "PNsamplephonenumber000000000000",
      "phoneNumberType": "shared",
      "userId": "USsampleus"
    },
    "links": {
      "quo": "https://my.quo.com/inbox/PNsamplephonenumber000000000000/c/CNsampleconversation000000000000?at=ACsampleactivity0000000000000000"
    },
    "resource": {
      "answeredAt": "2026-03-30T18:00:00.000Z",
      "completedAt": "2026-03-30T18:00:00.000Z",
      "createdAt": "2026-03-30T18:00:00.000Z",
      "direction": "incoming",
      "duration": 42,
      "hasVoicemail": false,
      "id": "ACsampleactivity0000000000000000",
      "status": "answered",
      "updatedAt": "2026-03-30T18:00:00.000Z"
    }
  }
}

{
  "message": "Invalid input format",
  "docs": "https://quo.com/docs",
  "title": "Invalid Input Format"
}

{
  "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": "Webhook with ID 123 not found",
  "docs": "https://quo.com/docs",
  "title": "Not Found"
}

{
  "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

Path Parameters

webhookId · string · required

The unique identifier of a webhook

Pattern: ^[0-9]+$

Example:

"123"

Body

application/json

eventType · enum<string> · required

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, integration.created, integration.updated, integration.deleted

Example:

"call.completed"

Response

200

application/json

OK

id · string · required

The event identifier inside the dispatched payload body — matches the id your endpoint will receive on the webhook POST. Note: this is a fixed sample identifier shared across test dispatches, not a per-delivery Svix message ID.

Example:

"msg_2abcDEFghiJKLmnoPQRstu"

apiVersion · enum<string> · required

The webhook payload version used to render this event.

Available options: 2026-03-30

Example:

"2026-03-30"

type · enum<string> · required

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, integration.created, integration.updated, integration.deleted

Example:

"call.completed"

createdAt · string<date-time> · required

When the test event was created.

data · any · required

Event-specific body. Shape depends on type — see the webhook event documentation.

Example:

{
  "context": {
    "contacts": {
      "ids": ["CTsampleContact01234"],
      "lookupStatus": "matched"
    },
    "conversationId": "CNsampleconversation000000000000",
    "participants": {
      "external": ["[phone]"],
      "resolution": "available",
      "workspace": ["[phone]"]
    },
    "phoneNumberId": "PNsamplephonenumber000000000000",
    "phoneNumberType": "shared",
    "userId": "USsampleus"
  },
  "links": {
    "quo": "https://my.quo.com/inbox/PNsamplephonenumber000000000000/c/CNsampleconversation000000000000?at=ACsampleactivity0000000000000000"
  },
  "resource": {
    "answeredAt": "2026-03-30T18:00:00.000Z",
    "completedAt": "2026-03-30T18:00:00.000Z",
    "createdAt": "2026-03-30T18:00:00.000Z",
    "direction": "incoming",
    "duration": 42,
    "hasVoicemail": false,
    "id": "ACsampleactivity0000000000000000",
    "status": "answered",
    "updatedAt": "2026-03-30T18:00:00.000Z"
  }
}