Create a pending StreetProof alert subscription

Creates or updates a pending alert subscription for StreetPulse-derived city, industry, or entity events. Matching events are queued, but external email/webhook delivery waits for verification, SMTP and partner controls.

post/api/v1/alerts/subscribe

Request

  • Base URL: https://streetproof.com
  • URL: https://streetproof.com/api/v1/alerts/subscribe
  • Auth: none required

Request body

emailstring email required
citystring required

City slug, e.g. calgary

channel'email' | 'dashboard' | 'webhook'
entity_public_idstring

Restrict alerts to one entity

industry_codestring

Restrict city alerts to one industry

event_typesstring[]
min_confidencenumber
webhook_urlstring uri

Required only when channel=webhook.

Response

Existing subscription updated

schema'com.streetproof.alert_subscription.v1'
okboolean

Changes

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