Notifications

Update a subscription

Any subset of { name, webhook_url, signing_secret, events, format, enabled, report_id }. Scope: routines.

patch/notifications/{id}

Request

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

Request body

namestring
webhook_urlstring uri
signing_secretstring nullable
eventsstring[]
format'slack' | 'discord' | 'plain'
enabledboolean
report_idstring uuid nullable

Response

Updated subscription.

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.