SurfacedBySurfacedBy Docs
DocumentationConsoleReference

Webhooks

Register endpoints to receive Console event deliveries, and inspect recent delivery history.

Ask an AI:Open in ChatGPTOpen in Claude

Webhook endpoints receive signed HTTP POSTs from SurfacedBy whenever events you subscribed to occur (scan lifecycle, credit top-ups, key activity). The register endpoint returns a signing secret exactly once; store it immediately, because the system cannot show it to you again. The per-endpoint GET returns delivery stats and a tail of recent attempts so you can debug without leaving the Console.

For the full event catalog and signature-verification algorithm, see Webhooks.

GET
/webhooks
/webhooks

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/webhooks" \
  -H "X-API-Key: string"

Successful Response

null

POST
/webhooks
/webhooks

Request Body

application/jsonRequired

[key: string]any

Header Parameters

X-API-KeyX-Api-Key

curl -X POST "https://example.com/webhooks" \
  -H "X-API-Key: string" \
  -H "Content-Type: application/json" \
  -d '{}'

Successful Response

null

GET
/webhooks/{endpoint_id}
/webhooks/{endpoint_id}

Path Parameters

endpoint_id
Required
Endpoint Id

Header Parameters

X-API-KeyX-Api-Key

curl -X GET "https://example.com/webhooks/string" \
  -H "X-API-Key: string"

Successful Response

null

DELETE
/webhooks/{endpoint_id}
/webhooks/{endpoint_id}

Path Parameters

endpoint_id
Required
Endpoint Id

Header Parameters

X-API-KeyX-Api-Key

curl -X DELETE "https://example.com/webhooks/string" \
  -H "X-API-Key: string"

Successful Response

null