Webhooks

Register a webhook endpoint

Register an HTTPS endpoint to receive signed artifact.flagged events. The response includes the signing secret once — store it now; verify incoming deliveries with the X-Faro-Signature header.

post/v1/me/webhooks

Request

  • Base URL: https://api.farofinance.app
  • URL: https://api.farofinance.app/v1/me/webhooks
  • Auth: none declared

Request body

urlstring required

HTTPS endpoint Faro POSTs signed events to.

eventsstring[] nullable

Events to subscribe to. Defaults to ["artifact.flagged"].

labelstring nullable

Optional human label for this endpoint.

Example request

{
  "url": "https://hooks.acme.com/faro"
}

Response

Successful Response

idstring required

Endpoint id, e.g. whk_….

urlstring required

Where events are delivered.

eventsstring[] required

Subscribed event types.

activeboolean required

Whether deliveries are currently sent.

labelstring nullable

Optional human label.

created_atstring date-time required

When the endpoint was registered.

secretstring required

HMAC signing secret (whsec_…). Store it now — it is never shown again.

Changes

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