Send a test event to a webhook

POST

/event-subscriptions/{id}/test

const url = 'https://app.surveyrock.com/api/v1/event-subscriptions/example/test';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://app.surveyrock.com/api/v1/event-subscriptions/example/test \
  --header 'Authorization: Bearer <token>'

Sends one signed webhook.test event to the subscription’s URL now, waits up to 10 seconds, and reports how the endpoint answered. It is tried once and not retried, and it does not change the subscription: a failing test does not count toward pausing it, and a passing one does not resume it. It appears in the delivery log. Works on a paused subscription, which is the point.

Authorizations

bearerAuth
events:write

Parameters

Path Parameters

required

string

Header Parameters

Idempotency-Key

string

>= 1 characters <= 128 characters

1 to 128 characters, chosen by the caller

Responses

200

data.delivered is whether the endpoint answered 2xx; outcome, status_code, error and response_excerpt say what happened

403

The plan does not include webhooks (feature_locked), or the token lacks events:write

404

subscription_not_found

409

subscription_is_pull: an event feed has no URL to send to