data_map

functions[].data_map defines how a SWAIG function should process and respond to the user’s input data.

Similar to a return statement in conventional programming languages, when a valid output is encountered within any component, it immediately terminates function execution. The output provides:

1. A response object: Contains static text for the AI agent’s context
2. An optional action object: Defines executable actions to be triggered

If no component produces a valid output, the system continues processing in sequence:

• First attempts expressions
• If unsuccessful, tries webhooks
• If still unsuccessful, attempts top-level output
• If all fail, returns a generic fallback error message

Properties

List of valid actions

Webhook runtime request

When the AI triggers a function that uses data_map.webhooks, SignalWire sends a request to each configured url.

Template variables

The url and params fields support %{variable} substitution. Nested properties use dot notation — for example, https://api.example.com/weather?city=%{args.location} substitutes the value the AI extracted for location. For more on variables and scopes, see the Variables reference.

Request body

When params is defined (or method is POST), SignalWire sends the params object as the JSON request body. Template variables in params values are expanded before sending.

If no params are defined and method is not POST, the request is sent without a body.

If input_args_as_params is true, the function arguments extracted by the AI are merged into params. If no params are defined, the arguments become the entire request body.

Response processing

The JSON response from the webhook is processed through the output template. Fields from the response can be referenced using %{key} syntax in the output’s response string. For example, if the webhook returns {"temp": 72, "conditions": "sunny"}, an output of "The weather is %{temp}°F with %{conditions}" will produce "The weather is 72°F with sunny".

Examples

expressions

1
data_map:
2
  expressions:
3
    - string: "starwars"
4
      pattern: "(?i)star\\s*wars"
5
      output:
6
        response: "May the Force be with you!"
7
    - string: "startrek"
8
      pattern: "(?i)star\\s*trek"
9
      output:
10
        response: "Live long and prosper!"

webhooks with explicit params

1
data_map:
2
  webhooks:
3
    - url: https://api.example.com/weather
4
      method: POST
5
      params:
6
        call_id: "%{call_id}"
7
        city: "%{args.location}"
8
      output:
9
        response: "The weather in %{city} is %{temp}°F and %{conditions}."

Sends the following request body to https://api.example.com/weather:

1
{
2
  "call_id": "xxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
3
  "city": "New York"
4
}

webhooks with input_args_as_params

1
data_map:
2
  webhooks:
3
    - url: https://api.example.com/weather
4
      method: POST
5
      input_args_as_params: true
6
      output:
7
        response: "The weather is %{temp}°F and %{conditions}."

Sends the AI-extracted arguments directly as the request body:

1
{
2
  "location": "New York"
3
}

output with action

1
sections:
2
  main:
3
    - amazon_bedrock:
4
        prompt:
5
          text: You are a helpful SignalWire assistant.
6
        SWAIG:
7
          functions:
8
            - function: test_function
9
              description: This is a test function.
10
              parameters:
11
                type: object
12
                properties:
13
                  name:
14
                    type: string
15
                    description: The name of the person.
16
                required:
17
                  - name
18
              data_map:
19
                output:
20
                  response: We are testing the function.
21
                  action:
22
                    - SWML:
23
                        sections:
24
                          main:
25
                            - play:
26
                                url: 'say:We are testing the function.'