Skip to main content
GET
Get the registered webhook for this API key
Returns the registered endpoint, the subscribed event types, and whether a signing secret is configured.
The signing secret itself is never returned. signing_secret_configured tells you only whether one is set. If you have lost your secret, rotate it with POST /webhooks/indexing/signing-secret rather than trying to read it back.
When no webhook is registered, registered is false and url is null. See Webhooks.

Authorizations

Authorization
string
header
required

API key sent as a Bearer token: "Bearer prefix.secret"

Response

200 - application/json

OK

data
object
Example:
error
object

Error message, empty string on success.

Example:
meta
object
Example:
success
boolean

Whether the request succeeded.

Example:

true