staff.requested webhook

The staff.requested webhook: the AI waiter called restaurant staff, for a routine request such as water or the check, or an escalation.

The waiter called staff: a routine request (source: "request", with kind, such as water or check) or an escalation (source: "escalation", with a reason such as allergen_severe, and urgency). Sent once per call: a call held as a repeat of one staff already have is not sent again. Never the waiter's or the diner's words. A test key's chat pages no one, but its calls are still sent as test events.

The data object

FieldTypeDescription
conversationIdstring1 to 200 characters.
externalUserIdstring or null1 to 200 characters.
branchstring or nullAn address: lower-case letters, digits and dashes.
tablestring or null1 to 40 characters.
sourcestringOne of request, escalation, unknown. An open list: read a value you don't know as unknown.
kindstringMay be absent. One of order_now, water, check, extra_napkins, refill, other. An open list: read a value you don't know as other.
reasonstringMay be absent. One of diner_requested_staff, allergen_severe, off_menu_question, order_placement, complaint, reservation, payment, unknown_other. An open list: read a value you don't know as unknown_other.
urgencystringMay be absent. One of normal, high, unknown. An open list: read a value you don't know as unknown.

Examples

staff.requested
{
  "type": "staff.requested",
  "timestamp": "2026-11-02T19:30:00.000Z",
  "livemode": true,
  "data": {
    "conversationId": "conv_0001",
    "externalUserId": "user-88213",
    "branch": "achrafieh",
    "table": "12",
    "source": "escalation",
    "reason": "allergen_severe",
    "urgency": "high"
  }
}
staff.requested
{
  "type": "staff.requested",
  "timestamp": "2026-11-02T19:31:00.000Z",
  "livemode": false,
  "data": {
    "conversationId": "conv_0002",
    "externalUserId": null,
    "branch": null,
    "table": null,
    "source": "request",
    "kind": "water"
  }
}

A test event

What Send a test event in the dashboard sends: livemode: false, and every id starting test_.

staff.requested, test
{
  "type": "staff.requested",
  "timestamp": "2026-11-16T12:00:00.000Z",
  "livemode": false,
  "data": {
    "conversationId": "test_conversation",
    "externalUserId": "test_user",
    "branch": null,
    "table": null,
    "source": "request",
    "kind": "water"
  }
}