Subscriptions
The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
Filters by email address or phone number.
In order to search by phone number, the following is supported:
- Full phone number. Ensure the country code is prefixed by a + sign and
include a space between the country code and phone number (e.g.
+49 000000000or+49 000 000 000) - Country code (e.g.
+49) - Phone number without country code (e.g.
000000000)
Used as a cursor for pagination.
Used as a cursor for pagination.
Set the number of subscriptions to return in the response. This defaults to 20 items, and can be a maximum of 100.
The list of subscriptions
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
Unexpected error.
GET /api/v2/status_pages/{subdomain}/subscriptions HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
"subscriptions": [
{
"type": "email",
"filter": "services",
"service_ids": [
1
],
"incident_types": [
"major"
],
"incident_id": 123,
"email": "jane@doe.com",
"confirm": true,
"country_dial_code": "49",
"phone_number": "12345678900",
"webhook_url": "https://discordapp.com/api/webhooks/channelId/token",
"locale": "en",
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"metadata": {
"data": "some data"
},
"subscription_group_ids": [
1,
2
]
}
],
"links": {
"next": "{STATUSPAL_HOST}/api/v2/status_pages/subdomain/subscriptions?after=cUrSoR",
"prev": "text"
},
"meta": {
"total_count": 100
}
}Adds a new subscription email, SMS or discord subscription
The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
The subscription was created
Bad request error. Probably JSON syntax is wrong, check with jsonlint.com.
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
There was a validation error
Unexpected error.
POST /api/v2/status_pages/{subdomain}/subscriptions HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 353
{
"subscription": {
"type": "email",
"filter": "services",
"service_ids": [
1
],
"incident_types": [
"major"
],
"incident_id": 123,
"email": "jane@doe.com",
"confirm": true,
"country_dial_code": "49",
"phone_number": "12345678900",
"webhook_url": "https://discordapp.com/api/webhooks/channelId/token",
"locale": "en",
"metadata": {
"data": "some data"
},
"subscription_group_ids": [
1,
2
]
}
}{
"subscription": {
"type": "email",
"filter": "services",
"service_ids": [
1
],
"incident_types": [
"major"
],
"incident_id": 123,
"email": "jane@doe.com",
"confirm": true,
"country_dial_code": "49",
"phone_number": "12345678900",
"webhook_url": "https://discordapp.com/api/webhooks/channelId/token",
"locale": "en",
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"metadata": {
"data": "some data"
},
"subscription_group_ids": [
1,
2
]
}
}The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
The ID of a subscription
The subscription
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
Unexpected error.
GET /api/v2/status_pages/{subdomain}/subscriptions/{subscriptionId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
"subscription": {
"type": "email",
"filter": "services",
"service_ids": [
1
],
"incident_types": [
"major"
],
"incident_id": 123,
"email": "jane@doe.com",
"confirm": true,
"country_dial_code": "49",
"phone_number": "12345678900",
"webhook_url": "https://discordapp.com/api/webhooks/channelId/token",
"locale": "en",
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"metadata": {
"data": "some data"
},
"subscription_group_ids": [
1,
2
]
}
}The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
The ID of a subscription
The subscription was updated
Bad request error. Probably JSON syntax is wrong, check with jsonlint.com.
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
There was a validation error
Unexpected error.
PUT /api/v2/status_pages/{subdomain}/subscriptions/{subscriptionId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 353
{
"subscription": {
"type": "email",
"filter": "services",
"service_ids": [
1
],
"incident_types": [
"major"
],
"incident_id": 123,
"email": "jane@doe.com",
"confirm": true,
"country_dial_code": "49",
"phone_number": "12345678900",
"webhook_url": "https://discordapp.com/api/webhooks/channelId/token",
"locale": "en",
"metadata": {
"data": "some data"
},
"subscription_group_ids": [
1,
2
]
}
}{
"subscription": {
"type": "email",
"filter": "services",
"service_ids": [
1
],
"incident_types": [
"major"
],
"incident_id": 123,
"email": "jane@doe.com",
"confirm": true,
"country_dial_code": "49",
"phone_number": "12345678900",
"webhook_url": "https://discordapp.com/api/webhooks/channelId/token",
"locale": "en",
"inserted_at": "2022-01-01T00:00:00",
"updated_at": "2022-01-01T00:00:00",
"metadata": {
"data": "some data"
},
"subscription_group_ids": [
1,
2
]
}
}The subdomain of your status page.
You can find this under your status page settings, the Subdomain field is found under the "Domain name" section. Alternatively find it in the URL of your admin dashboard (e.g. statuspal.io/admin/subdomain).
The ID of a subscription
Subscription deleted successfully
Authorization information is missing or invalid.
You lack the necessary permissions to access this resource.
A resource with the provided ID was not found.
Unexpected error.
DELETE /api/v2/status_pages/{subdomain}/subscriptions/{subscriptionId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
No content
Last updated