Webhooks

Send a test event

Sends a test.ping to the endpoint now, whether or not it is enabled, with one attempt and no retries, and reports the result. A failed test never counts toward switching the endpoint off. At most 10 a minute. Personal access tokens receive 403.

Required token scopes are listed in x-hootlens-scopes. A signed-in person needs the matching permission on the site instead (the viewer and editor roles are presets of the permissions).

post/v1/projects/{projectId}/webhooks/{endpointId}/test

Request

  • Base URL: https://hootlens-api-368877148687.us-east1.run.app
  • URL: https://hootlens-api-368877148687.us-east1.run.app/v1/projects/{projectId}/webhooks/{endpointId}/test
  • Auth: HTTP bearer

Path parameters

projectIdstring required

An identifier: 1 to 80 letters, digits, underscores or hyphens.

The project ID. Project IDs are public identifiers, not secrets.

endpointIdstring required

An identifier: 1 to 80 letters, digits, underscores or hyphens.

A webhook endpoint ID.

Request body

event'test.ping'

Response

The delivery and whether it succeeded.

okboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.