Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.scrubbe.com/llms.txt

Use this file to discover all available pages before exploring further.

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

​
rules
object[]
required
Array of silent-hours rule objects.
curl --request GET \
  --url https://your-api-domain.com/api/v1/silent-hours \
  --header 'Authorization: Bearer YOUR_TOKEN'

​
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

​
rules
object[]
required
The complete list of silent-hours rules to activate. Replaces all current rules.

​
Response fields

​
rules
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
      }
    ]
  }'

​
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

​
id
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
  }'

​
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

​
id
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'