body | SignalWire

Set the request body for the most recently added webhook. Used for POST/PUT requests. Writes to the body key of the webhook definition.

body() and params() write to different keys in the webhook specification: body sets the request body, while params sets query/form parameters.

Parameters

data

Record<string, unknown>Required

Request body data. Supports ${variable} substitutions.

Returns

DataMap — Self for method chaining. Throws an Error if no webhook has been added yet.

Example

1 import { DataMap, FunctionResult } from '@signalwire/sdk';
2 
3 const search = new DataMap('search_docs');
4 search
5   .purpose('Search documentation')
6   .parameter('query', 'string', 'Search query', { required: true })
7   .webhook('POST', 'https://api.docs.example.com/search', {
8     headers: { Authorization: 'Bearer TOKEN' },
9   })
10   .body({ query: '${args.query}', limit: 3 })
11   .output(new FunctionResult('Found: ${response.results[0].title}'));

1	import { DataMap, FunctionResult } from '@signalwire/sdk';
2
3	const search = new DataMap('search_docs');
4	search
5	.purpose('Search documentation')
6	.parameter('query', 'string', 'Search query', { required: true })
7	.webhook('POST', 'https://api.docs.example.com/search', {
8	headers: { Authorization: 'Bearer TOKEN' },
9	})
10	.body({ query: '${args.query}', limit: 3 })
11	.output(new FunctionResult('Found: ${response.results[0].title}'));