Trigger automation webhook
curl --request POST \
--url https://api.voxworks.ai/api/v1/hooks/{token} \
--header 'Content-Type: application/json' \
--data '
{
"contact_phone": "0429069971",
"source": "crm"
}
'const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({contact_phone: '0429069971', source: 'crm'})
};
fetch('https://api.voxworks.ai/api/v1/hooks/{token}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voxworks.ai/api/v1/hooks/{token}"
payload = {
"contact_phone": "0429069971",
"source": "crm"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"execution_id": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "Invalid API key"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "Rate limit exceeded"
}{
"success": false,
"message": "Internal server error"
}Webhooks
Trigger automation webhook
Receive an inbound webhook POST and enqueue an automation execution. This endpoint uses a webhook token in the path instead of bearer API-key authentication.
POST
/
api
/
v1
/
hooks
/
{token}
Trigger automation webhook
curl --request POST \
--url https://api.voxworks.ai/api/v1/hooks/{token} \
--header 'Content-Type: application/json' \
--data '
{
"contact_phone": "0429069971",
"source": "crm"
}
'const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({contact_phone: '0429069971', source: 'crm'})
};
fetch('https://api.voxworks.ai/api/v1/hooks/{token}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.voxworks.ai/api/v1/hooks/{token}"
payload = {
"contact_phone": "0429069971",
"source": "crm"
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"success": true,
"execution_id": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "Invalid API key"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "<string>"
}{
"success": false,
"message": "Rate limit exceeded"
}{
"success": false,
"message": "Internal server error"
}Headers
SHA-256 HMAC signature when the webhook has a secret configured.
Optional idempotency key to prevent duplicate automation executions.
Path Parameters
Body
application/json
The body is of type object.

