Class WebhookResponse

Verb builder for HTTP webhook applications. Construct one per request, chain verb methods, and pass to res.json().

Example

app.post('/incoming', (req, res) => {
  const jambonz = new WebhookResponse();
  jambonz.say({ text: 'Hello!' }).hangup();
  res.json(jambonz);
});

Hierarchy (View Summary)

VerbBuilder
- WebhookResponse

Index

Constructors

constructor

new WebhookResponse(opts?: VerbBuilderOptions): WebhookResponse
Parameters
- Optionalopts: VerbBuilderOptions
  Options for validation and schema directory.
Returns WebhookResponse
Overrides VerbBuilder.constructor
- Defined in src/webhook/response.ts:26

Properties

`Protected`verbs

verbs: Verb[] = []

`Protected`validator

validator: JambonzValidator | null

Accessors

length

get length(): number
Get the current verb count.

Returns number
Inherited from VerbBuilder.length
- Defined in src/verb-builder.ts:274

Methods

say

say(opts: Omit<SayVerb, "verb">): this
Speak text using TTS. Supports SSML, multiple voices, and streaming.
Parameters
- opts: Omit<SayVerb, "verb">
Returns this
Inherited from VerbBuilder.say
- Defined in src/verb-builder.ts:69

play

play(opts: Omit<PlayVerb, "verb">): this
Play an audio file from a URL.
Parameters
- opts: Omit<PlayVerb, "verb">
Returns this
Inherited from VerbBuilder.play
- Defined in src/verb-builder.ts:74

gather

gather(opts: Omit<GatherVerb, "verb">): this
Collect speech (STT) and/or DTMF input from the caller.
Parameters
- opts: Omit<GatherVerb, "verb">
Returns this
Inherited from VerbBuilder.gather
- Defined in src/verb-builder.ts:79

llm

llm(opts: Omit<LlmVerb, "verb">): this
Connect the caller to an LLM for real-time voice conversation.
Parameters
- opts: Omit<LlmVerb, "verb">
Returns this
Inherited from VerbBuilder.llm
- Defined in src/verb-builder.ts:86

s2s

s2s(opts: Omit<S2sVerb, "verb">): this
Synonym for llm. Requires vendor to be specified.
Parameters
- opts: Omit<S2sVerb, "verb">
Returns this
Inherited from VerbBuilder.s2s
- Defined in src/verb-builder.ts:91

openai_s2s

openai_s2s(opts: Omit<LlmBaseOptions, "vendor">): this
Shortcut for s2s with vendor='openai'.
Parameters
- opts: Omit<LlmBaseOptions, "vendor">
Returns this
Inherited from VerbBuilder.openai_s2s
- Defined in src/verb-builder.ts:96

google_s2s

google_s2s(opts: Omit<LlmBaseOptions, "vendor">): this
Shortcut for s2s with vendor='google'.
Parameters
- opts: Omit<LlmBaseOptions, "vendor">
Returns this
Inherited from VerbBuilder.google_s2s
- Defined in src/verb-builder.ts:101

elevenlabs_s2s

elevenlabs_s2s(opts: Omit<LlmBaseOptions, "vendor">): this
Shortcut for s2s with vendor='elevenlabs'.
Parameters
- opts: Omit<LlmBaseOptions, "vendor">
Returns this
Inherited from VerbBuilder.elevenlabs_s2s
- Defined in src/verb-builder.ts:106

deepgram_s2s

deepgram_s2s(opts: Omit<LlmBaseOptions, "vendor">): this
Shortcut for s2s with vendor='deepgram'.
Parameters
- opts: Omit<LlmBaseOptions, "vendor">
Returns this
Inherited from VerbBuilder.deepgram_s2s
- Defined in src/verb-builder.ts:111

ultravox_s2s

ultravox_s2s(opts: Omit<LlmBaseOptions, "vendor">): this
Shortcut for s2s with vendor='ultravox'.
Parameters
- opts: Omit<LlmBaseOptions, "vendor">
Returns this
Inherited from VerbBuilder.ultravox_s2s
- Defined in src/verb-builder.ts:116

dialogflow

dialogflow(opts: Omit<DialogflowVerb, "verb">): this
Connect the caller to a Google Dialogflow agent (ES, CX, or CES).
Parameters
- opts: Omit<DialogflowVerb, "verb">
Returns this
Inherited from VerbBuilder.dialogflow
- Defined in src/verb-builder.ts:121

agent

agent(opts: Omit<AgentVerb, "verb">): this
Voice AI agent with integrated turn detection.
Parameters
- opts: Omit<AgentVerb, "verb">
Returns this
Inherited from VerbBuilder.agent
- Defined in src/verb-builder.ts:126

listen

listen(opts: Omit<ListenVerb, "verb">): this
Stream real-time call audio to a WebSocket endpoint. Supports bidirectional audio.
Parameters
- opts: Omit<ListenVerb, "verb">
Returns this
Inherited from VerbBuilder.listen
- Defined in src/verb-builder.ts:131

stream

stream(opts: Omit<StreamVerb, "verb">): this
Stream real-time call audio to a WebSocket endpoint. Synonym for listen.
Parameters
- opts: Omit<StreamVerb, "verb">
Returns this
Inherited from VerbBuilder.stream
- Defined in src/verb-builder.ts:136

transcribe

transcribe(opts: Omit<TranscribeVerb, "verb">): this
Real-time call transcription sent to a webhook.
Parameters
- opts: Omit<TranscribeVerb, "verb">
Returns this
Inherited from VerbBuilder.transcribe
- Defined in src/verb-builder.ts:141

dial

dial(opts: Omit<DialVerb, "verb">): this
Place an outbound call and bridge it to the current caller.
Parameters
- opts: Omit<DialVerb, "verb">
Returns this
Inherited from VerbBuilder.dial
- Defined in src/verb-builder.ts:148

conference

conference(opts: Omit<ConferenceVerb, "verb">): this
Join or create a multi-party conference room.
Parameters
- opts: Omit<ConferenceVerb, "verb">
Returns this
Inherited from VerbBuilder.conference
- Defined in src/verb-builder.ts:153

enqueue

enqueue(opts: Omit<EnqueueVerb, "verb">): this
Place the caller into a named queue.
Parameters
- opts: Omit<EnqueueVerb, "verb">
Returns this
Inherited from VerbBuilder.enqueue
- Defined in src/verb-builder.ts:158

dequeue

dequeue(opts: Omit<DequeueVerb, "verb">): this
Remove a caller from a queue and bridge them.
Parameters
- opts: Omit<DequeueVerb, "verb">
Returns this
Inherited from VerbBuilder.dequeue
- Defined in src/verb-builder.ts:163

hangup

hangup(opts?: Omit<HangupVerb, "verb">): this
End the call.
Parameters
- Optionalopts: Omit<HangupVerb, "verb">
Returns this
Inherited from VerbBuilder.hangup
- Defined in src/verb-builder.ts:168

redirect

redirect(opts: Omit<RedirectVerb, "verb">): this
Transfer control to a different webhook URL.
Parameters
- opts: Omit<RedirectVerb, "verb">
Returns this
Inherited from VerbBuilder.redirect
- Defined in src/verb-builder.ts:173

pause

pause(opts: Omit<PauseVerb, "verb">): this
Wait for a specified duration before continuing.
Parameters
- opts: Omit<PauseVerb, "verb">
Returns this
Inherited from VerbBuilder.pause
- Defined in src/verb-builder.ts:178

leave

leave(opts?: Omit<LeaveVerb, "verb">): this
Leave a conference or queue.
Parameters
- Optionalopts: Omit<LeaveVerb, "verb">
Returns this
Inherited from VerbBuilder.leave
- Defined in src/verb-builder.ts:183

sipDecline

sipDecline(opts: Omit<SipDeclineVerb, "verb">): this
Reject an incoming call with a SIP error response.
Parameters
- opts: Omit<SipDeclineVerb, "verb">
Returns this
Inherited from VerbBuilder.sipDecline
- Defined in src/verb-builder.ts:190

sipRequest

sipRequest(opts: Omit<SipRequestVerb, "verb">): this
Send a SIP INFO or other request within the dialog.
Parameters
- opts: Omit<SipRequestVerb, "verb">
Returns this
Inherited from VerbBuilder.sipRequest
- Defined in src/verb-builder.ts:195

sipRefer

sipRefer(opts: Omit<SipReferVerb, "verb">): this
Transfer the call via SIP REFER.
Parameters
- opts: Omit<SipReferVerb, "verb">
Returns this
Inherited from VerbBuilder.sipRefer
- Defined in src/verb-builder.ts:200

config

config(opts: Omit<ConfigVerb, "verb">): this
Set session-level defaults (TTS vendor/voice, STT vendor, VAD, etc.).
Parameters
- opts: Omit<ConfigVerb, "verb">
Returns this
Inherited from VerbBuilder.config
- Defined in src/verb-builder.ts:207

answer

answer(opts?: Omit<AnswerVerb, "verb">): this
Explicitly answer the call (sends a 200 OK).
Parameters
- Optionalopts: Omit<AnswerVerb, "verb">
Returns this
Inherited from VerbBuilder.answer
- Defined in src/verb-builder.ts:212

alert

alert(opts: Omit<AlertVerb, "verb">): this
Send a SIP 180 Ringing with optional Alert-Info header.
Parameters
- opts: Omit<AlertVerb, "verb">
Returns this
Inherited from VerbBuilder.alert
- Defined in src/verb-builder.ts:217

dtmf

dtmf(opts: Omit<DtmfVerb, "verb">): this
Send DTMF tones into the call.
Parameters
- opts: Omit<DtmfVerb, "verb">
Returns this
Inherited from VerbBuilder.dtmf
- Defined in src/verb-builder.ts:227

dub

dub(opts: Omit<DubVerb, "verb">): this
Mix an auxiliary audio track into the call.
Parameters
- opts: Omit<DubVerb, "verb">
Returns this
Inherited from VerbBuilder.dub
- Defined in src/verb-builder.ts:232

message

message(opts: Omit<MessageVerb, "verb">): this
Send an SMS or MMS message.
Parameters
- opts: Omit<MessageVerb, "verb">
Returns this
Inherited from VerbBuilder.message
- Defined in src/verb-builder.ts:237

addVerbs

addVerbs(verbs: Verb[]): this
Add one or more verbs from raw JSON. Validates against the JSON schemas at runtime if validation is enabled.
Parameters
- verbs: Verb[]
Returns this
Inherited from VerbBuilder.addVerbs
- Defined in src/verb-builder.ts:247

`Protected`addVerb

addVerb(verb: Verb): this
Parameters
- verb: Verb
Returns this
Inherited from VerbBuilder.addVerb
- Defined in src/verb-builder.ts:261

clear

clear(): this
Clear all queued verbs.

Returns this
Inherited from VerbBuilder.clear
- Defined in src/verb-builder.ts:279

toJSON

toJSON(): JambonzApp
Returns the verb array for JSON serialization.

Returns JambonzApp
Overrides VerbBuilder.toJSON
- Defined in src/webhook/response.ts:31

`Static`verifySignature

verifySignature(
    secret: string,
    opts?: { tolerance?: number },
): (
    req: IncomingMessage & {
        body?: unknown;
        rawBody?: Buffer<ArrayBufferLike>;
    },
    _res: ServerResponse,
    next: (err?: Error) => void,
) => void
Express-compatible middleware for verifying jambonz webhook signatures. Uses HMAC-SHA256 with timing-safe comparison.
Parameters
- secret: string
- Optionalopts: { tolerance?: number }
Returns (
    req: IncomingMessage & {
        body?: unknown;
        rawBody?: Buffer<ArrayBufferLike>;
    },
    _res: ServerResponse,
    next: (err?: Error) => void,
) => void
- Defined in src/webhook/response.ts:39

Class WebhookResponse

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebhookResponse

Properties

Protectedverbs

Protectedvalidator

Accessors

length

Returns number

Methods

say

Parameters

Returns this

play

Parameters

Returns this

gather

Parameters

Returns this

llm

Parameters

Returns this

s2s

Parameters

Returns this

openai_s2s

Parameters

Returns this

google_s2s

Parameters

Returns this

elevenlabs_s2s

Parameters

Returns this

deepgram_s2s

Parameters

Returns this

ultravox_s2s

Parameters

Returns this

dialogflow

Parameters

Returns this

agent

Parameters

Returns this

listen

Parameters

Returns this

stream

Parameters

Returns this

transcribe

Parameters

Returns this

dial

Parameters

Returns this

conference

Parameters

Returns this

enqueue

Parameters

Returns this

dequeue

Parameters

Returns this

hangup

Parameters

Returns this

redirect

`Protected`verbs

`Protected`validator

`Protected`addVerb

`Static`verifySignature

Returns (
req: IncomingMessage & {
body?: unknown;
rawBody?: Buffer<ArrayBufferLike>;
},
_res: ServerResponse,
next: (err?: Error) => void,
) => void