alerts

Create an alert rule on brands the workspace tracks: a trigger (new ads, confirmed stopped ads, page changes, new partners or activity coverage), a delivery cadence, and its channels (email to the creator, optional https webhook or Slack incoming webhook). The first webhook rule answers the workspace's webhook signing secret once.

Create an alert rule on brands the workspace tracks: a trigger (new ads, confirmed stopped ads, page changes, new partners or activity coverage), a delivery cadence, and its channels (email to the creator, optional https webhook or Slack incoming webhook). The first webhook rule answers the workspace's webhook signing secret once. Scope alerts:write; cache none.

post/v1/workspaces/{ws}/alerts

Request

  • Base URL: https://api.storequant.com
  • URL: https://api.storequant.com/v1/workspaces/{ws}/alerts
  • Auth: HTTP bearer

Path parameters

wsstring required

Request body

namestring required
event_type'new_ads' | 'paused_ads' | 'page_change' | 'new_partner' | 'coverage' required
brand_idsstring[] required
cadence'daily' | 'weekly'
enabledboolean
emailboolean
webhook_urlstring uri
webhook_kind'generic' | 'slack'

Response

Success.

Changes

No recorded changes to this operation across all 2 revisions of this API.