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>"
}
'

200

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

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.