Skip to main content
POST
/
catchAll
/
webhooks
/
{webhook_id}
/
test
Test webhook delivery
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"
  }
}
'
{
  "success": true,
  "message": "Test delivery succeeded.",
  "http_status_code": 200,
  "response_body": "ok"
}

Documentation Index

Fetch the complete documentation index at: https://newscatcherinc-docs.mintlify.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API key for authentication.

Path Parameters

​
webhook_id
string<uuid>
required

Unique webhook identifier.

Body

application/json
​
payload
object

Custom payload to send in the test request. If omitted, a synthetic test payload is sent.

Example:
{
  "test": true,
  "message": "CatchAll webhook test"
}

Response

Test delivery attempted. Check success and http_status_code for the outcome.

​
success
boolean
required

True if the test delivery received a 2xx response; false otherwise.

Example:

true

​
message
string
required

Human-readable result message.

Example:

"Test delivery succeeded."

​
http_status_code
integer

HTTP status code returned by the webhook endpoint.

Example:

200

​
response_body
any

Response body returned by the webhook endpoint. Type varies by target.

Example:

"ok"