Webhook subscriptions

Send a test event

POSThttps://api.ruuster.com/v1/webhooks/{webhookId}/test

Send a webhook.test event to the subscription's URL now and return what your endpoint answered.

Authentication: x-api-key and x-email headers of an owner or admin
Rate limit: 120 requests per minute per key
Changes only your webhook subscriptions, never your Ruuster data

No body. The delivery is signed like any other, so it also tests your signature check.

Path parameters

Name	Type	Description
`webhookId`	string	The subscription id, `whk_…`

deliveryId, eventId, statusCode and latencyMs of the attempt. On success it also has responseBodyPreview (the start of your endpoint's answer); on failure it has error instead, for example Timed out after 10s.

Request

curl -s -X POST "https://api.ruuster.com/v1/webhooks/whk_2c7f9a4e1b/test" \
  -H "x-api-key: $RUUSTER_API_KEY" \
  -H "x-email: $RUUSTER_EMAIL"

const res = await fetch("https://api.ruuster.com/v1/webhooks/whk_2c7f9a4e1b/test", {
  method: "POST",
  headers: {
    "x-api-key": process.env.RUUSTER_API_KEY,
    "x-email": process.env.RUUSTER_EMAIL,
  },
});
const body = await res.json();
if (!body.ok) throw new Error(`${body.error.code}: ${body.error.message} (${body.requestId})`);
console.log(body.data);

import os
import requests

res = requests.post(
    "https://api.ruuster.com/v1/webhooks/whk_2c7f9a4e1b/test",
    headers={"x-api-key": os.environ["RUUSTER_API_KEY"], "x-email": os.environ["RUUSTER_EMAIL"]},
    timeout=30,
)
body = res.json()
if not body["ok"]:
    raise RuntimeError(f'{body["error"]["code"]}: {body["error"]["message"]} ({body.get("requestId")})')
print(body["data"])

Send a test event

Path parameters

Response