Get the org-default notification settings

GET

/v1/notifications

const url = 'https://api.overwatch.weareheavy.dev/v1/notifications';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.overwatch.weareheavy.dev/v1/notifications \
  --header 'Authorization: Bearer <token>'

The organization’s default notification receivers, plus which sites override them. Session-only, owner/admin.

Authorizations

BearerAuth

Responses

200

The org defaults and the overriding site ids.

application/json

object

settings

required

Notification receivers for one scope (org defaults or a site override). On reads every field is present; on writes all fields are optional — omitted fields keep their current value. At most 10 recipients and 5 webhooks per list.

object

uptimeRecipients

Receivers of uptime incident alerts (down/recovered).

Array

<= 10 items

One of:

object
object

object

kind

required

string

Allowed value: user

userId

required

string

uptimeWebhooks

Webhooks for uptime incident alerts.

Array<object>

<= 5 items

A notification webhook. slack, discord, and teams format the message for the respective chat app; http POSTs a structured JSON payload to any endpoint.

object

kind

required

string

Allowed values: slack discord teams http

url

required

string format: uri

crawlReportRecipients

Receivers of the per-run crawl summary (broken links + accessibility).

Array

<= 10 items

One of:

object
object

object

kind

required

string

Allowed value: user

userId

required

string

searchAlertRecipients

Receivers of search-traffic-drop alerts (Search Console).

Array

<= 10 items

One of:

object
object

object

kind

required

string

Allowed value: user

userId

required

string

searchAlertWebhooks

Webhooks for search-traffic-drop alerts.

Array<object>

<= 5 items

A notification webhook. slack, discord, and teams format the message for the respective chat app; http POSTs a structured JSON payload to any endpoint.

object

kind

required

string

Allowed values: slack discord teams http

url

required

string format: uri

perfAlertRecipients

Receivers of Core Web Vitals regression alerts.

Array

<= 10 items

One of:

object
object

object

kind

required

string

Allowed value: user

userId

required

string

perfAlertWebhooks

Webhooks for Core Web Vitals regression alerts.

Array<object>

<= 5 items

A notification webhook. slack, discord, and teams format the message for the respective chat app; http POSTs a structured JSON payload to any endpoint.

object

kind

required

string

Allowed values: slack discord teams http

url

required

string format: uri

reportRecipients

Receivers of the scheduled branded stakeholder report (PDF attachment).

Array

<= 10 items

One of:

object
object

object

kind

required

string

Allowed value: user

userId

required

string

includeOrgDefaults

Site overrides only — union the org defaults back in at delivery time. Meaningless on the org-defaults scope itself.

boolean

default: true

overrides

required

The sites that carry their own override row.

Array<object>

object

siteId

required

string format: uuid

hostname

required

string

Example

{
  "settings": {
    "uptimeRecipients": [
      {
        "kind": "user"
      }
    ],
    "uptimeWebhooks": [
      {
        "kind": "slack"
      }
    ],
    "crawlReportRecipients": [
      {
        "kind": "user"
      }
    ],
    "searchAlertRecipients": [
      {
        "kind": "user"
      }
    ],
    "searchAlertWebhooks": [
      {
        "kind": "slack"
      }
    ],
    "perfAlertRecipients": [
      {
        "kind": "user"
      }
    ],
    "perfAlertWebhooks": [
      {
        "kind": "slack"
      }
    ],
    "reportRecipients": [
      {
        "kind": "user"
      }
    ],
    "includeOrgDefaults": true
  }
}

401

Missing or invalid credentials.

application/json

object

error

required

A human-readable error message.

string

Example

{
  "error": "invalid api key"
}

403

A dashboard session is required (API-key callers are rejected), or the session’s role does not allow this action.

application/json

object

error

required

A human-readable error message.

string

Example

{
  "error": "a dashboard session is required"
}