Test Webhook

Send a test payload to the webhook configured for a stream monitor. Returns the HTTP status code and response time from the webhook endpoint. Useful for verifying webhook connectivity before going live.

POST /v1/twitter/stream/webhooks/test

Test webhook

cURL

curl --request POST \
  --url https://scrapebadger.com/v1/twitter/stream/webhooks/test \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "monitor_id": "<string>"
}
'

import requests

url = "https://scrapebadger.com/v1/twitter/stream/webhooks/test"

payload = { "monitor_id": "<string>" }
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({monitor_id: '<string>'})
};

fetch('https://scrapebadger.com/v1/twitter/stream/webhooks/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://scrapebadger.com/v1/twitter/stream/webhooks/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([
    'monitor_id' => '<string>'
  ]),
  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://scrapebadger.com/v1/twitter/stream/webhooks/test"

	payload := strings.NewReader("{\n  \"monitor_id\": \"<string>\"\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://scrapebadger.com/v1/twitter/stream/webhooks/test")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"monitor_id\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://scrapebadger.com/v1/twitter/stream/webhooks/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  \"monitor_id\": \"<string>\"\n}"

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

200

{
  "success": true,
  "status_code": 123,
  "response_time_ms": 123,
  "error": "<string>"
}

{
  "error": "Invalid or missing API key"
}

{
  "error": "Insufficient credits"
}

{
  "error": "Rate limit exceeded. Please retry after a short delay."
}

Authorizations

x-api-key · string · header · required

Your ScrapeBadger API key. You can find this in your dashboard at https://scrapebadger.com/dashboard/api-keys.

Body

application/json

Test webhook request.

monitor_id · string · required

The ID of the stream monitor whose webhook to test.

Response

200

application/json

Webhook test result.

success · boolean

Whether the webhook responded with a 2xx status code.

status_code · integer | null

HTTP status code returned by the webhook endpoint.

response_time_ms · number | null

Response time in milliseconds.

error · string | null

Error message if the webhook test failed.