Silent Hours API: Manage Notification Quiet Periods

Silent hours rules tell the platform when to hold non-urgent alerts rather than immediately paging team members. This is useful for protecting engineers outside business hours without disabling notifications entirely. Each rule targets a specific team, specifies a time range and timezone, and can be scoped to selected days of the week. All requests require a Bearer token in the Authorization header.

List all silent-hours rules

GET https://your-api-domain.com/api/v1/silent-hours Returns all silent-hours rules configured for the business.

Response fields

object[]

required

Array of silent-hours rule objects.

Show rule properties

string

required

Unique identifier for the rule.

string

required

Descriptive name for the rule.

string

required

Time when silence begins, in HH:MM 24-hour format.

string

required

Time when silence ends, in HH:MM 24-hour format.

string

required

IANA timezone identifier (e.g., America/New_York).

number[]

required

Days the rule is active. 1 = Monday through 7 = Sunday.

string

required

Team slug or identifier this rule applies to.

boolean

required

Whether the rule is currently enforced.

curl --request GET \
  --url https://your-api-domain.com/api/v1/silent-hours \
  --header 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch(
  'https://your-api-domain.com/api/v1/silent-hours',
  {
    headers: { Authorization: 'Bearer YOUR_TOKEN' },
  }
);
const data = await response.json();

import requests

response = requests.get(
    'https://your-api-domain.com/api/v1/silent-hours',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
)
data = response.json()

Replace all silent-hours rules

POST https://your-api-domain.com/api/v1/silent-hours

This endpoint replaces all existing silent-hours rules for the business with the set provided in the request body. Any rules not included in the payload will be permanently deleted. To preserve existing rules, retrieve them first with GET /silent-hours, modify the array, and re-submit.

Submits a complete, authoritative list of silent-hours rules. The operation is atomic: the entire set is replaced in a single transaction.

Request body

object[]

required

The complete list of silent-hours rules to activate. Replaces all current rules.

Show rule properties

string

required

A descriptive label for the rule.

string

required

Time when silence begins, in HH:MM 24-hour format.

string

required

Time when silence ends, in HH:MM 24-hour format. Can be earlier than startTime to span midnight.

string

required

IANA timezone identifier for interpreting startTime and endTime.

number[]

required

Array of day numbers the rule applies to. 1 = Monday, 2 = Tuesday, …, 7 = Sunday.

string

required

The team slug or identifier this rule should suppress notifications for.

boolean

default:"true"

required

Set to false to save the rule without enforcing it.

Response fields

object[]

required

The full set of rules now active, each with a server-assigned id.

curl --request POST \
  --url https://your-api-domain.com/api/v1/silent-hours \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "rules": [
      {
        "name": "Frontend Platform",
        "startTime": "21:00",
        "endTime": "08:00",
        "timezone": "America/New_York",
        "daysOfWeek": [1, 2, 3, 4, 5],
        "teamScope": "frontend-team",
        "isActive": true
      }
    ]
  }'

const response = await fetch(
  'https://your-api-domain.com/api/v1/silent-hours',
  {
    method: 'POST',
    headers: {
      Authorization: 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      rules: [
        {
          name: 'Frontend Platform',
          startTime: '21:00',
          endTime: '08:00',
          timezone: 'America/New_York',
          daysOfWeek: [1, 2, 3, 4, 5],
          teamScope: 'frontend-team',
          isActive: true,
        },
      ],
    }),
  }
);
const data = await response.json();

import requests

response = requests.post(
    'https://your-api-domain.com/api/v1/silent-hours',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
    json={
        'rules': [
            {
                'name': 'Frontend Platform',
                'startTime': '21:00',
                'endTime': '08:00',
                'timezone': 'America/New_York',
                'daysOfWeek': [1, 2, 3, 4, 5],
                'teamScope': 'frontend-team',
                'isActive': True,
            }
        ]
    },
)
data = response.json()

Update a rule

PUT https://your-api-domain.com/api/v1/silent-hours/:id Updates a single existing silent-hours rule by ID. Supply the full rule body; all fields are replaced.

Path parameters

string

required

The unique identifier of the rule to update.

Request body

Accepts the same fields as the individual rule objects in Replace all rules.

curl --request PUT \
  --url https://your-api-domain.com/api/v1/silent-hours/rule_xyz789 \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "Frontend Platform (updated)",
    "startTime": "22:00",
    "endTime": "08:00",
    "timezone": "America/New_York",
    "daysOfWeek": [1, 2, 3, 4, 5, 6],
    "teamScope": "frontend-team",
    "isActive": true
  }'

const response = await fetch(
  'https://your-api-domain.com/api/v1/silent-hours/rule_xyz789',
  {
    method: 'PUT',
    headers: {
      Authorization: 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      name: 'Frontend Platform (updated)',
      startTime: '22:00',
      endTime: '08:00',
      timezone: 'America/New_York',
      daysOfWeek: [1, 2, 3, 4, 5, 6],
      teamScope: 'frontend-team',
      isActive: true,
    }),
  }
);
const data = await response.json();

import requests

response = requests.put(
    'https://your-api-domain.com/api/v1/silent-hours/rule_xyz789',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
    json={
        'name': 'Frontend Platform (updated)',
        'startTime': '22:00',
        'endTime': '08:00',
        'timezone': 'America/New_York',
        'daysOfWeek': [1, 2, 3, 4, 5, 6],
        'teamScope': 'frontend-team',
        'isActive': True,
    },
)
data = response.json()

Delete a rule

DELETE https://your-api-domain.com/api/v1/silent-hours/:id Removes a single silent-hours rule. Other rules are unaffected.

Path parameters

string

required

The unique identifier of the rule to delete.

curl --request DELETE \
  --url https://your-api-domain.com/api/v1/silent-hours/rule_xyz789 \
  --header 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch(
  'https://your-api-domain.com/api/v1/silent-hours/rule_xyz789',
  {
    method: 'DELETE',
    headers: { Authorization: 'Bearer YOUR_TOKEN' },
  }
);

import requests

requests.delete(
    'https://your-api-domain.com/api/v1/silent-hours/rule_xyz789',
    headers={'Authorization': 'Bearer YOUR_TOKEN'},
)

Overview

Incidents & Tickets

Intelligence

Operations

Platform

Silent Hours API: Manage Notification Quiet Periods

List all silent-hours rules

Response fields

Replace all silent-hours rules

Request body

Response fields

Update a rule

Path parameters

Request body

Delete a rule

Path parameters

​List all silent-hours rules

​Response fields

​Replace all silent-hours rules

​Request body

​Response fields

​Update a rule

​Path parameters

​Request body

​Delete a rule

​Path parameters

List all silent-hours rules

Response fields

Replace all silent-hours rules

Request body

Response fields

Update a rule

Path parameters

Request body

Delete a rule

Path parameters