Triggers
Create Trigger
Creates a new global trigger
POST
/
api
/
triggers
cURL
curl --request POST \
--url https://api.ultravox.ai/api/triggers \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"trigger": {
"name": "<string>",
"event": {
"dataMessage": "<string>",
"timer": "<string>"
},
"condition": {
"property": "<string>",
"propertyArguments": {},
"value": "<unknown>",
"conditions": "<array>"
},
"actions": [
{
"dataMessage": {},
"ternary": {
"condition": {
"property": "<string>",
"propertyArguments": {},
"value": "<unknown>",
"conditions": "<array>"
},
"whenTrue": "<array>",
"whenFalse": "<array>"
},
"setLocalVariable": {
"name": "<string>",
"value": "<unknown>"
},
"incrementLocalVariable": {
"name": "<string>",
"value": 123
},
"startTimer": {
"name": "<string>",
"delay": "<string>"
},
"cancelTimer": {
"name": "<string>"
}
}
],
"localVariables": {}
}
}
'import requests
url = "https://api.ultravox.ai/api/triggers"
payload = { "trigger": {
"name": "<string>",
"event": {
"dataMessage": "<string>",
"timer": "<string>"
},
"condition": {
"property": "<string>",
"propertyArguments": {},
"value": "<unknown>",
"conditions": "<array>"
},
"actions": [
{
"dataMessage": {},
"ternary": {
"condition": {
"property": "<string>",
"propertyArguments": {},
"value": "<unknown>",
"conditions": "<array>"
},
"whenTrue": "<array>",
"whenFalse": "<array>"
},
"setLocalVariable": {
"name": "<string>",
"value": "<unknown>"
},
"incrementLocalVariable": {
"name": "<string>",
"value": 123
},
"startTimer": {
"name": "<string>",
"delay": "<string>"
},
"cancelTimer": { "name": "<string>" }
}
],
"localVariables": {}
} }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
trigger: {
name: '<string>',
event: {dataMessage: '<string>', timer: '<string>'},
condition: {
property: '<string>',
propertyArguments: {},
value: '<unknown>',
conditions: '<array>'
},
actions: [
{
dataMessage: {},
ternary: {
condition: {
property: '<string>',
propertyArguments: {},
value: '<unknown>',
conditions: '<array>'
},
whenTrue: '<array>',
whenFalse: '<array>'
},
setLocalVariable: {name: '<string>', value: '<unknown>'},
incrementLocalVariable: {name: '<string>', value: 123},
startTimer: {name: '<string>', delay: '<string>'},
cancelTimer: {name: '<string>'}
}
],
localVariables: {}
}
})
};
fetch('https://api.ultravox.ai/api/triggers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ultravox.ai/api/triggers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'trigger' => [
'name' => '<string>',
'event' => [
'dataMessage' => '<string>',
'timer' => '<string>'
],
'condition' => [
'property' => '<string>',
'propertyArguments' => [
],
'value' => '<unknown>',
'conditions' => '<array>'
],
'actions' => [
[
'dataMessage' => [
],
'ternary' => [
'condition' => [
'property' => '<string>',
'propertyArguments' => [
],
'value' => '<unknown>',
'conditions' => '<array>'
],
'whenTrue' => '<array>',
'whenFalse' => '<array>'
],
'setLocalVariable' => [
'name' => '<string>',
'value' => '<unknown>'
],
'incrementLocalVariable' => [
'name' => '<string>',
'value' => 123
],
'startTimer' => [
'name' => '<string>',
'delay' => '<string>'
],
'cancelTimer' => [
'name' => '<string>'
]
]
],
'localVariables' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ultravox.ai/api/triggers"
payload := strings.NewReader("{\n \"trigger\": {\n \"name\": \"<string>\",\n \"event\": {\n \"dataMessage\": \"<string>\",\n \"timer\": \"<string>\"\n },\n \"condition\": {\n \"property\": \"<string>\",\n \"propertyArguments\": {},\n \"value\": \"<unknown>\",\n \"conditions\": \"<array>\"\n },\n \"actions\": [\n {\n \"dataMessage\": {},\n \"ternary\": {\n \"condition\": {\n \"property\": \"<string>\",\n \"propertyArguments\": {},\n \"value\": \"<unknown>\",\n \"conditions\": \"<array>\"\n },\n \"whenTrue\": \"<array>\",\n \"whenFalse\": \"<array>\"\n },\n \"setLocalVariable\": {\n \"name\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"incrementLocalVariable\": {\n \"name\": \"<string>\",\n \"value\": 123\n },\n \"startTimer\": {\n \"name\": \"<string>\",\n \"delay\": \"<string>\"\n },\n \"cancelTimer\": {\n \"name\": \"<string>\"\n }\n }\n ],\n \"localVariables\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ultravox.ai/api/triggers")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"trigger\": {\n \"name\": \"<string>\",\n \"event\": {\n \"dataMessage\": \"<string>\",\n \"timer\": \"<string>\"\n },\n \"condition\": {\n \"property\": \"<string>\",\n \"propertyArguments\": {},\n \"value\": \"<unknown>\",\n \"conditions\": \"<array>\"\n },\n \"actions\": [\n {\n \"dataMessage\": {},\n \"ternary\": {\n \"condition\": {\n \"property\": \"<string>\",\n \"propertyArguments\": {},\n \"value\": \"<unknown>\",\n \"conditions\": \"<array>\"\n },\n \"whenTrue\": \"<array>\",\n \"whenFalse\": \"<array>\"\n },\n \"setLocalVariable\": {\n \"name\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"incrementLocalVariable\": {\n \"name\": \"<string>\",\n \"value\": 123\n },\n \"startTimer\": {\n \"name\": \"<string>\",\n \"delay\": \"<string>\"\n },\n \"cancelTimer\": {\n \"name\": \"<string>\"\n }\n }\n ],\n \"localVariables\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ultravox.ai/api/triggers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"trigger\": {\n \"name\": \"<string>\",\n \"event\": {\n \"dataMessage\": \"<string>\",\n \"timer\": \"<string>\"\n },\n \"condition\": {\n \"property\": \"<string>\",\n \"propertyArguments\": {},\n \"value\": \"<unknown>\",\n \"conditions\": \"<array>\"\n },\n \"actions\": [\n {\n \"dataMessage\": {},\n \"ternary\": {\n \"condition\": {\n \"property\": \"<string>\",\n \"propertyArguments\": {},\n \"value\": \"<unknown>\",\n \"conditions\": \"<array>\"\n },\n \"whenTrue\": \"<array>\",\n \"whenFalse\": \"<array>\"\n },\n \"setLocalVariable\": {\n \"name\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"incrementLocalVariable\": {\n \"name\": \"<string>\",\n \"value\": 123\n },\n \"startTimer\": {\n \"name\": \"<string>\",\n \"delay\": \"<string>\"\n },\n \"cancelTimer\": {\n \"name\": \"<string>\"\n }\n }\n ],\n \"localVariables\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"triggerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"trigger": {
"name": "<string>",
"event": {
"dataMessage": "<string>",
"timer": "<string>"
},
"condition": {
"property": "<string>",
"propertyArguments": {},
"operator": "OPERATOR_UNSPECIFIED",
"value": "<unknown>",
"conditions": "<array>"
},
"actions": [
{
"dataMessage": {},
"ternary": {
"condition": {
"property": "<string>",
"propertyArguments": {},
"operator": "OPERATOR_UNSPECIFIED",
"value": "<unknown>",
"conditions": "<array>"
},
"whenTrue": "<array>",
"whenFalse": "<array>"
},
"setLocalVariable": {
"name": "<string>",
"value": "<unknown>"
},
"incrementLocalVariable": {
"name": "<string>",
"value": 123
},
"startTimer": {
"name": "<string>",
"delay": "<string>"
},
"cancelTimer": {
"name": "<string>"
}
}
],
"localVariables": {}
},
"ownership": "public"
}See Global Triggers for how calls and agents use it.
Authorizations
API key
Body
application/json
A rule that sends data messages into a call when an event occurs and a condition is met. Triggers run shortly after their events, in the order the events occur, so their actions may interleave with other activity in the call. If one of its conditions can't be evaluated, that run of the trigger stops, and a trigger whose runs fail three times in a row is dropped for the rest of the call.
Show child attributes
Show child attributes
Response
201 - application/json
A rule that sends data messages into a call when an event occurs and a condition is met. Triggers run shortly after their events, in the order the events occur, so their actions may interleave with other activity in the call. If one of its conditions can't be evaluated, that run of the trigger stops, and a trigger whose runs fail three times in a row is dropped for the rest of the call.
Show child attributes
Show child attributes
Available options:
public, private ⌘I
cURL
curl --request POST \
--url https://api.ultravox.ai/api/triggers \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"trigger": {
"name": "<string>",
"event": {
"dataMessage": "<string>",
"timer": "<string>"
},
"condition": {
"property": "<string>",
"propertyArguments": {},
"value": "<unknown>",
"conditions": "<array>"
},
"actions": [
{
"dataMessage": {},
"ternary": {
"condition": {
"property": "<string>",
"propertyArguments": {},
"value": "<unknown>",
"conditions": "<array>"
},
"whenTrue": "<array>",
"whenFalse": "<array>"
},
"setLocalVariable": {
"name": "<string>",
"value": "<unknown>"
},
"incrementLocalVariable": {
"name": "<string>",
"value": 123
},
"startTimer": {
"name": "<string>",
"delay": "<string>"
},
"cancelTimer": {
"name": "<string>"
}
}
],
"localVariables": {}
}
}
'import requests
url = "https://api.ultravox.ai/api/triggers"
payload = { "trigger": {
"name": "<string>",
"event": {
"dataMessage": "<string>",
"timer": "<string>"
},
"condition": {
"property": "<string>",
"propertyArguments": {},
"value": "<unknown>",
"conditions": "<array>"
},
"actions": [
{
"dataMessage": {},
"ternary": {
"condition": {
"property": "<string>",
"propertyArguments": {},
"value": "<unknown>",
"conditions": "<array>"
},
"whenTrue": "<array>",
"whenFalse": "<array>"
},
"setLocalVariable": {
"name": "<string>",
"value": "<unknown>"
},
"incrementLocalVariable": {
"name": "<string>",
"value": 123
},
"startTimer": {
"name": "<string>",
"delay": "<string>"
},
"cancelTimer": { "name": "<string>" }
}
],
"localVariables": {}
} }
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
trigger: {
name: '<string>',
event: {dataMessage: '<string>', timer: '<string>'},
condition: {
property: '<string>',
propertyArguments: {},
value: '<unknown>',
conditions: '<array>'
},
actions: [
{
dataMessage: {},
ternary: {
condition: {
property: '<string>',
propertyArguments: {},
value: '<unknown>',
conditions: '<array>'
},
whenTrue: '<array>',
whenFalse: '<array>'
},
setLocalVariable: {name: '<string>', value: '<unknown>'},
incrementLocalVariable: {name: '<string>', value: 123},
startTimer: {name: '<string>', delay: '<string>'},
cancelTimer: {name: '<string>'}
}
],
localVariables: {}
}
})
};
fetch('https://api.ultravox.ai/api/triggers', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.ultravox.ai/api/triggers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'trigger' => [
'name' => '<string>',
'event' => [
'dataMessage' => '<string>',
'timer' => '<string>'
],
'condition' => [
'property' => '<string>',
'propertyArguments' => [
],
'value' => '<unknown>',
'conditions' => '<array>'
],
'actions' => [
[
'dataMessage' => [
],
'ternary' => [
'condition' => [
'property' => '<string>',
'propertyArguments' => [
],
'value' => '<unknown>',
'conditions' => '<array>'
],
'whenTrue' => '<array>',
'whenFalse' => '<array>'
],
'setLocalVariable' => [
'name' => '<string>',
'value' => '<unknown>'
],
'incrementLocalVariable' => [
'name' => '<string>',
'value' => 123
],
'startTimer' => [
'name' => '<string>',
'delay' => '<string>'
],
'cancelTimer' => [
'name' => '<string>'
]
]
],
'localVariables' => [
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.ultravox.ai/api/triggers"
payload := strings.NewReader("{\n \"trigger\": {\n \"name\": \"<string>\",\n \"event\": {\n \"dataMessage\": \"<string>\",\n \"timer\": \"<string>\"\n },\n \"condition\": {\n \"property\": \"<string>\",\n \"propertyArguments\": {},\n \"value\": \"<unknown>\",\n \"conditions\": \"<array>\"\n },\n \"actions\": [\n {\n \"dataMessage\": {},\n \"ternary\": {\n \"condition\": {\n \"property\": \"<string>\",\n \"propertyArguments\": {},\n \"value\": \"<unknown>\",\n \"conditions\": \"<array>\"\n },\n \"whenTrue\": \"<array>\",\n \"whenFalse\": \"<array>\"\n },\n \"setLocalVariable\": {\n \"name\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"incrementLocalVariable\": {\n \"name\": \"<string>\",\n \"value\": 123\n },\n \"startTimer\": {\n \"name\": \"<string>\",\n \"delay\": \"<string>\"\n },\n \"cancelTimer\": {\n \"name\": \"<string>\"\n }\n }\n ],\n \"localVariables\": {}\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.ultravox.ai/api/triggers")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"trigger\": {\n \"name\": \"<string>\",\n \"event\": {\n \"dataMessage\": \"<string>\",\n \"timer\": \"<string>\"\n },\n \"condition\": {\n \"property\": \"<string>\",\n \"propertyArguments\": {},\n \"value\": \"<unknown>\",\n \"conditions\": \"<array>\"\n },\n \"actions\": [\n {\n \"dataMessage\": {},\n \"ternary\": {\n \"condition\": {\n \"property\": \"<string>\",\n \"propertyArguments\": {},\n \"value\": \"<unknown>\",\n \"conditions\": \"<array>\"\n },\n \"whenTrue\": \"<array>\",\n \"whenFalse\": \"<array>\"\n },\n \"setLocalVariable\": {\n \"name\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"incrementLocalVariable\": {\n \"name\": \"<string>\",\n \"value\": 123\n },\n \"startTimer\": {\n \"name\": \"<string>\",\n \"delay\": \"<string>\"\n },\n \"cancelTimer\": {\n \"name\": \"<string>\"\n }\n }\n ],\n \"localVariables\": {}\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ultravox.ai/api/triggers")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"trigger\": {\n \"name\": \"<string>\",\n \"event\": {\n \"dataMessage\": \"<string>\",\n \"timer\": \"<string>\"\n },\n \"condition\": {\n \"property\": \"<string>\",\n \"propertyArguments\": {},\n \"value\": \"<unknown>\",\n \"conditions\": \"<array>\"\n },\n \"actions\": [\n {\n \"dataMessage\": {},\n \"ternary\": {\n \"condition\": {\n \"property\": \"<string>\",\n \"propertyArguments\": {},\n \"value\": \"<unknown>\",\n \"conditions\": \"<array>\"\n },\n \"whenTrue\": \"<array>\",\n \"whenFalse\": \"<array>\"\n },\n \"setLocalVariable\": {\n \"name\": \"<string>\",\n \"value\": \"<unknown>\"\n },\n \"incrementLocalVariable\": {\n \"name\": \"<string>\",\n \"value\": 123\n },\n \"startTimer\": {\n \"name\": \"<string>\",\n \"delay\": \"<string>\"\n },\n \"cancelTimer\": {\n \"name\": \"<string>\"\n }\n }\n ],\n \"localVariables\": {}\n }\n}"
response = http.request(request)
puts response.read_body{
"triggerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created": "2023-11-07T05:31:56Z",
"trigger": {
"name": "<string>",
"event": {
"dataMessage": "<string>",
"timer": "<string>"
},
"condition": {
"property": "<string>",
"propertyArguments": {},
"operator": "OPERATOR_UNSPECIFIED",
"value": "<unknown>",
"conditions": "<array>"
},
"actions": [
{
"dataMessage": {},
"ternary": {
"condition": {
"property": "<string>",
"propertyArguments": {},
"operator": "OPERATOR_UNSPECIFIED",
"value": "<unknown>",
"conditions": "<array>"
},
"whenTrue": "<array>",
"whenFalse": "<array>"
},
"setLocalVariable": {
"name": "<string>",
"value": "<unknown>"
},
"incrementLocalVariable": {
"name": "<string>",
"value": 123
},
"startTimer": {
"name": "<string>",
"delay": "<string>"
},
"cancelTimer": {
"name": "<string>"
}
}
],
"localVariables": {}
},
"ownership": "public"
}