POST/v2/statuspages/{uuid}/subscribers

Add a subscriber

Adds a new subscriber to a status page. Subscribers added via API are automatically confirmed.

ℹ️Note

Slack subscribers must be added through the Slack OAuth flow and cannot be added via API.

Request

Path Parameters

uuidstringrequired

The status page UUID

Example:"sp_xyz789abc"

Bodyapplication/json

typeenum<string>required

Subscriber type

Available options:

emailsmsteams

emailstringconditional

Email address. Required if type is email

Example:"user@example.com"

phonestringconditional

Phone number with country code. Required if type is sms

Example:"+1234567890"

teams_webhook_urlstringconditional

Teams webhook URL. Required if type is teams

languagestringoptional

Preferred language code. Default: en

Response

Returns the newly created subscriber.

RequestcURL

curl -X POST https://api.hyperping.io/v2/statuspages/sp_xyz789abc/subscribers \
  -H "Authorization: Bearer ${API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "email",
    "email": "user@example.com",
    "language": "en"
  }'

201 CreatedJSON

{
  "message": "Subscriber added",
  "subscriber": {
    "id": 12346,
    "type": "email",
    "email": "user@example.com",
    "phone": null,
    "teams_webhook_url": null
  }
}

← List subscribers Delete a subscriber →