Notifications

Create a subscription

Subscribe a webhook to report events. Omit report_id to match every report the owner owns, was invited to, or shares with their team (public link access doesn't count). signing_secret (encrypted at rest, never returned) enables HMAC-signed deliveries. Scope: routines.

post/notifications

Request

  • Base URL: https://commareports.com/api/v1
  • URL: https://commareports.com/api/v1/notifications
  • Auth: HTTP bearer

Request body

namestring

Defaults to 'Untitled notification'.

report_idstring uuid nullable

Scope to one report (must be viewable) or null for all.

webhook_urlstring uri required

http(s) only.

signing_secretstring nullable

Enables HMAC-signed deliveries. Encrypted at rest; never returned.

eventsstring[]

Defaults to all four event types.

format'slack' | 'discord' | 'plain'

Response

Subscription created.

idstring uuid required
report_idstring uuid nullable

null = every report the owner owns, was invited to, or shares with their team.

namestring required
webhook_urlstring uri required
eventsstring[] required
format'slack' | 'discord' | 'plain' required
enabledboolean required
last_delivered_atstring date-time nullable
last_delivery_statusstring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

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