Create an alert (not metered)

Create an alert that tells the user when a new period of an indicator is published for a place, or when a published value is revised. Use it for "notify me when Spain's CPI is out", "tell me when Texas unemployment is revised", "alert me when my saved chart gets new data". Target: indicator and place (as in get_value), optionally source to follow one publisher only; or workspace_item, the id of a saved chart or table, which follows every place of the item (Pro plan, like the workspace). Channels: "email" (default) to the account's own address, one message per release run or a daily digest with email_mode "daily"; "webhook" to an HTTPS URL, signed with Standard Webhooks headers (Builder and Pro); "feed" for agents that poll list_changes instead. Examples: {"indicator": "cpi_annual_change", "place": "Spain"}. {"indicator": "unemployment_rate", "place": "Texas", "events": ["revision"]}. {"workspace_item": "wsp_3f9a...", "channel": "webhook", "webhook_url": "https://example.com/hooks/invokely"}. Returns {alert: {id, label, target, events, channel, status, ...}, created, secret?, warnings?}. secret (webhooks only) is shown once: tell the user to store it to verify signatures. Free keeps 5 alerts, Builder 50, Pro 500. Alert calls do not use the monthly allowance.

post/api/v1/alerts

Request

  • Base URL: https://invokely.ai
  • URL: https://invokely.ai/api/v1/alerts
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key
    • none

Request body

indicatorstring

Indicator id, for example "cpi_annual_change" or "unemployment_rate". Use search_indicators when unsure.

placestring

Place name or id, for example "Spain", "Texas", "es-mun-08121".

sourcestring

Optional source id (the source.id of get_value), to follow one publisher only. Omit to hear about every source of the series.

workspace_itemstring

Instead of indicator and place: a saved chart or table id from workspace_list.

eventsstring[]

What to be told about: "new_period" (a period not published before) and "revision" (a published value or its status changed). Default both.

channel'email' | 'webhook' | 'feed'

Default "email".

webhook_urlstring

channel "webhook" only. A public HTTPS URL that accepts POST requests.

email_mode'instant' | 'daily'

channel "email" only. "instant" (default): one email per release run; "daily": one digest a day.

labelstring

Optional name shown in emails and lists.

Response

An identical alert already existed: {alert, created: false, warnings}.

dataunknown required

Changes

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