formulas

post/api/v1/alerts

Request

  • Base URL: https://api.blackforge.so (the document declares no server; this is the origin it was published from)
  • URL: https://api.blackforge.so/api/v1/alerts
  • Auth: API key in header x-api-key

Request body

formulaIdstring required

The formula to watch (fml_…).

direction'above' | 'below' | 'cross' required
thresholdnumber required

The value you set.

hysteresisnumber

How far back across the value the formula must move before it can notify again. Absolute, default 0.

cooldownSecondsnumber

Seconds before it can notify again, 60 to 86400. Default 900.

emailboolean

Email the account's verified address. Default true. The address is never an argument.

webhookUrlstring

An https URL we POST each notification to, signed with x-blackforge-signature. API keys only.

Response

Tells you when your formula crosses the value you set, by email to the account address and/or a signed https webhook. The webhook secret is returned once. Ultra only; any other plan gets 403 {"error":{"code":"plan_required","plan":"ultra","upgrade":"https://blackforge.so/pricing"}}.

Changes

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