Webhooks

Send a test event

POSTs one sample payload to your URL right now and hands back what came back. It goes through the same delivery path as a real event — same headers, same signature, and it is recorded in the delivery list — but it deliberately ignores enabled and your event subscription, because the question it answers is whether your endpoint works before you turn delivery on. The payload carries obviously fake sample data. Requires webhooks:write.

POST

webhook

test

Send a test event

curl --request POST \
  --url https://api.voice.wixzel.com/v1/webhook/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "callCompleted"
}
'

import requests

url = "https://api.voice.wixzel.com/v1/webhook/test"

payload = { "event": "callCompleted" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({event: 'callCompleted'})
};

fetch('https://api.voice.wixzel.com/v1/webhook/test', 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.voice.wixzel.com/v1/webhook/test",
  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([
    'event' => 'callCompleted'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.voice.wixzel.com/v1/webhook/test"

	payload := strings.NewReader("{\n  \"event\": \"callCompleted\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.voice.wixzel.com/v1/webhook/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event\": \"callCompleted\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.voice.wixzel.com/v1/webhook/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event\": \"callCompleted\"\n}"

response = http.request(request)
puts response.read_body

{
  "object": "webhook_delivery",
  "event": "callCompleted",
  "url": "<string>",
  "attempt": 123,
  "status": "delivered",
  "response_status": 123,
  "error": "<string>",
  "duration_ms": 123,
  "will_retry": true,
  "occurred_at": "2026-09-01T12:00:00.000Z"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Your Wixzel Voice API key: Authorization: Bearer wv_live_.... Keys are scoped; grant only what the integration needs.

Body

application/json

event

enum<string>

required

Which event to simulate. The payload carries obviously fake sample data.

Available options:

inboundCall,

outboundCall,

callCompleted,

leadCreated,

leadQualified,

campaignCompleted,

appointmentBooked,

appointmentCanceled,

callTransferred,

transferFailed

Example:

"callCompleted"

Response

What your endpoint answered

object

enum<string>

required

Available options:

webhook_delivery

event

enum<string>

required

The value of the event field in the delivered payload.

Available options:

inboundCall,

outboundCall,

callCompleted,

leadCreated,

leadQualified,

campaignCompleted,

appointmentBooked,

appointmentCanceled,

callTransferred,

transferFailed

Example:

"callCompleted"

url

string

required

Where this attempt was sent — the URL configured at the time, not the current one.

attempt

integer

required

1 for the first POST of an event. Each attempt is its own record.

status

enum<string>

required

delivered means a 2xx. Nothing else counts, including a 3xx.

Available options:

delivered,

failed

response_status

integer | null

required

Your endpoint's HTTP status, or null when nothing answered — DNS failure, refused connection, or timeout.

error

string | null

required

Why it failed, at the transport level. Never your response body: a receiver that echoes the payload back would otherwise store it here.

duration_ms

integer

required

will_retry

boolean

required

True when another attempt was scheduled. Retries run in-process, so a deploy between attempts drops the pending one.

occurred_at

string<date-time>

required

ISO 8601, always UTC.

Example:

"2026-09-01T12:00:00.000Z"

Send a test event

curl --request POST \
  --url https://api.voice.wixzel.com/v1/webhook/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "event": "callCompleted"
}
'

import requests

url = "https://api.voice.wixzel.com/v1/webhook/test"

payload = { "event": "callCompleted" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({event: 'callCompleted'})
};

fetch('https://api.voice.wixzel.com/v1/webhook/test', 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.voice.wixzel.com/v1/webhook/test",
  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([
    'event' => 'callCompleted'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.voice.wixzel.com/v1/webhook/test"

	payload := strings.NewReader("{\n  \"event\": \"callCompleted\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	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.voice.wixzel.com/v1/webhook/test")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"event\": \"callCompleted\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.voice.wixzel.com/v1/webhook/test")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"event\": \"callCompleted\"\n}"

response = http.request(request)
puts response.read_body

{
  "object": "webhook_delivery",
  "event": "callCompleted",
  "url": "<string>",
  "attempt": 123,
  "status": "delivered",
  "response_status": 123,
  "error": "<string>",
  "duration_ms": 123,
  "will_retry": true,
  "occurred_at": "2026-09-01T12:00:00.000Z"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "agent_not_found",
    "message": "<string>",
    "request_id": "req_01HXYZ...",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

Getting started

Guides

Carriers

Concepts

API reference

Send a test event

Authorizations

Body

Response