Alerts

Watch an artifact for flag alerts

Register mandate-scoped interest in a normalized artifact node. When the node gains a critical/high signal, Faro POSTs an artifact.flagged webhook to your registered endpoints — even if you have not checked this node recently.

post/v1/me/watch

Request

  • Base URL: https://api.farofinance.app
  • URL: https://api.farofinance.app/v1/me/watch
  • Auth: HTTP bearer

Request body

type'url' | 'payee' | 'message' | 'document' required
valuestring required

Artifact to watch.

Response

Successful Response

artifact_idstring required
messagestring required

Changes

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