curl --request POST \
--url https://catchall.newscatcherapi.com/catchAll/webhooks/{webhook_id}/test \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"payload": {
"test": true,
"message": "CatchAll webhook test"
}
}
'import requests
url = "https://catchall.newscatcherapi.com/catchAll/webhooks/{webhook_id}/test"
payload = { "payload": {
"test": True,
"message": "CatchAll webhook test"
} }
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({payload: {test: true, message: 'CatchAll webhook test'}})
};
fetch('https://catchall.newscatcherapi.com/catchAll/webhooks/{webhook_id}/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://catchall.newscatcherapi.com/catchAll/webhooks/{webhook_id}/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([
'payload' => [
'test' => true,
'message' => 'CatchAll webhook test'
]
]),
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://catchall.newscatcherapi.com/catchAll/webhooks/{webhook_id}/test"
payload := strings.NewReader("{\n \"payload\": {\n \"test\": true,\n \"message\": \"CatchAll webhook test\"\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://catchall.newscatcherapi.com/catchAll/webhooks/{webhook_id}/test")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"payload\": {\n \"test\": true,\n \"message\": \"CatchAll webhook test\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://catchall.newscatcherapi.com/catchAll/webhooks/{webhook_id}/test")
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 \"payload\": {\n \"test\": true,\n \"message\": \"CatchAll webhook test\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Test delivery succeeded.",
"http_status_code": 200,
"response_body": "ok"
}{
"detail": "Invalid API key"
}{
"detail": "Invalid API key"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Test webhook delivery
Sends a test HTTP request to the webhook URL using the webhook’s configured method, headers, and auth. Returns the response from the target endpoint.
Use this to verify URL reachability and authentication before attaching the webhook to a live job or monitor.
curl --request POST \
--url https://catchall.newscatcherapi.com/catchAll/webhooks/{webhook_id}/test \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"payload": {
"test": true,
"message": "CatchAll webhook test"
}
}
'import requests
url = "https://catchall.newscatcherapi.com/catchAll/webhooks/{webhook_id}/test"
payload = { "payload": {
"test": True,
"message": "CatchAll webhook test"
} }
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({payload: {test: true, message: 'CatchAll webhook test'}})
};
fetch('https://catchall.newscatcherapi.com/catchAll/webhooks/{webhook_id}/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://catchall.newscatcherapi.com/catchAll/webhooks/{webhook_id}/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([
'payload' => [
'test' => true,
'message' => 'CatchAll webhook test'
]
]),
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://catchall.newscatcherapi.com/catchAll/webhooks/{webhook_id}/test"
payload := strings.NewReader("{\n \"payload\": {\n \"test\": true,\n \"message\": \"CatchAll webhook test\"\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://catchall.newscatcherapi.com/catchAll/webhooks/{webhook_id}/test")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"payload\": {\n \"test\": true,\n \"message\": \"CatchAll webhook test\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://catchall.newscatcherapi.com/catchAll/webhooks/{webhook_id}/test")
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 \"payload\": {\n \"test\": true,\n \"message\": \"CatchAll webhook test\"\n }\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Test delivery succeeded.",
"http_status_code": 200,
"response_body": "ok"
}{
"detail": "Invalid API key"
}{
"detail": "Invalid API key"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
API key for authentication.
Path Parameters
Unique webhook identifier.
Body
Custom payload to send in the test request. If omitted, a synthetic test payload is sent.
{ "test": true, "message": "CatchAll webhook test" }
Response
Test delivery attempted. Check success and http_status_code for the outcome.
True if the test delivery received a 2xx response; false otherwise.
true
Human-readable result message.
"Test delivery succeeded."
HTTP status code returned by the webhook endpoint.
200
Response body returned by the webhook endpoint. Type varies by target.
"ok"
Was this page helpful?

