Skip to main content
POST
/
catchAll
/
webhook
/
trigger
/
{resource_type}
/
{resource_id}
Manually trigger webhook delivery
curl --request POST \
  --url https://catchall.newscatcherapi.com/catchAll/webhook/trigger/{resource_type}/{resource_id} \
  --header 'x-api-key: <api-key>'
import requests

url = "https://catchall.newscatcherapi.com/catchAll/webhook/trigger/{resource_type}/{resource_id}"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)
const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://catchall.newscatcherapi.com/catchAll/webhook/trigger/{resource_type}/{resource_id}', 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/webhook/trigger/{resource_type}/{resource_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

	url := "https://catchall.newscatcherapi.com/catchAll/webhook/trigger/{resource_type}/{resource_id}"

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

	req.Header.Add("x-api-key", "<api-key>")

	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/webhook/trigger/{resource_type}/{resource_id}")
  .header("x-api-key", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://catchall.newscatcherapi.com/catchAll/webhook/trigger/{resource_type}/{resource_id}")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "detail": "Invalid API key"
}
{
  "detail": "Invalid API key"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

x-api-key
string
header
required

API key for authentication.

Path Parameters

resource_type
enum<string>
required

Resource types that can be assigned to a webhook.

Available options:
job,
monitor,
monitor_group
resource_id
string<uuid>
required

Unique resource identifier.

Query Parameters

webhook_id
string<uuid>
required

Identifier of the webhook to trigger. Must be assigned to the resource.

job_id
string<uuid>

Specific job run to deliver. Optional for job resources; for monitor and monitor_group resources, selects a past run to replay. When omitted, the latest available results are delivered.

Response

Webhook delivery triggered.