Send a test event API

POST /v1/monitors/{monitor_id}/test

Send a signed test event ("type": "test") to the monitor's webhook now and report what the receiver answered. Free; nothing is stored.

• Cost: Free
• Cache: Not cached.

Parameters#

Example request#

Set your key in the environment first (see Authentication).

1curl -X POST "https://api.socialscrape.dev/v1/monitors/mon_0123456789abcdef/test" \2  -H "x-api-key: $SOCIALSCRAPE_API_KEY"

1import os2import requests34res = requests.post(5    "https://api.socialscrape.dev/v1/monitors/mon_0123456789abcdef/test",6    headers={"x-api-key": os.environ["SOCIALSCRAPE_API_KEY"]},7)8body = res.json()910if body["ok"]:11    print(body["data"])12else:13    print(body["error"]["code"], body["error"]["message"])

1const res = await fetch("https://api.socialscrape.dev/v1/monitors/mon_0123456789abcdef/test", {2  method: "POST",3  headers: { "x-api-key": process.env.SOCIALSCRAPE_API_KEY! },4});5const body = await res.json();67if (body.ok) {8  console.log(body.data);9} else {10  console.error(body.error.code, body.error.message);11}

Example response#

This is a sample with illustrative values. Status 200.

1{2  "ok": true,3  "credits_charged": 0,4  "credits_remaining": 5000,5  "cached": false,6  "cached_at": null,7  "request_id": "req_125748a7f0deee6f71dc2c2a",8  "data": {9    "object": "webhook_test",10    "monitor_id": "mon_0123456789abcdef",11    "delivered": true,12    "status_code": 200,13    "error": null14  },15  "cursor": null,16  "has_more": null17}

Response#

A WebhookTest object in data.

See Data models for every field. The envelope around data is described in Responses.

Errors#

Failures are free: credits_charged is 0. Branch on error.code, never on the message.

Every request can also fail with the account and platform errors listed on the Errors page.

Related endpoints#

• Create a monitor (POST /v1/monitors)
• List monitors (GET /v1/monitors)
• Delete a monitor (DELETE /v1/monitors/{monitor_id})
• Webhook delivery log (GET /v1/monitors/{monitor_id}/deliveries)
• Send an event again (POST /v1/monitors/events/{event_id}/redeliver)
• Monitor events (GET /v1/monitors/events)