foreach | SignalWire

Process an array from the webhook response, building a formatted string from each element.

Parameters

config

{ input_key: string; output_key: string; append: string; max?: number }Required

Configuration object with the following keys:

config.input_key

stringRequired

Key in the API response containing the array.

config.output_key

stringRequired

Variable name for the built string (reference as ${output_key} in output).

config.max

number

Maximum number of items to process.

config.append

stringRequired

Template string to append for each item. Use ${this.field} to reference fields on the current array element.

Returns

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

Example

1 import { DataMap } from '@signalwire/sdk';
2 
3 const dm = new DataMap('list_items');
4 dm.webhook('GET', 'https://api.example.com/items');
5 dm.foreach({
6   input_key: 'response.items',
7   output_key: 'item_list',
8   append: '${this.name}: ${this.price}',
9   max: 5,
10 });