For the complete documentation index, see llms.txt. This page is also available as Markdown.

Webhooks

Webhooks endpoints

List all webhooks

get
/status_pages/{subdomain}/webhooks
Authorizations
AuthorizationstringRequired
Path parameters
subdomainstringRequired

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).

Responses
200

The list of webhooks

application/json
get/status_pages/{subdomain}/webhooks
GET /api/v2/status_pages/{subdomain}/webhooks HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "webhooks": [
    {
      "url": "url",
      "events": [
        "incident.created",
        "incident.updated"
      ],
      "enabled": true
    }
  ]
}

Adds a new webhook

post
/status_pages/{subdomain}/webhooks
Authorizations
AuthorizationstringRequired
Path parameters
subdomainstringRequired

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).

Body
Responses
200

The webhook was created

application/json
post/status_pages/{subdomain}/webhooks
POST /api/v2/status_pages/{subdomain}/webhooks HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "webhook": {
    "url": "url",
    "events": [
      "incident.created",
      "incident.updated"
    ],
    "enabled": true
  }
}
{
  "webhook": {
    "url": "url",
    "events": [
      "incident.created",
      "incident.updated"
    ],
    "enabled": true
  }
}

Get a webhook

get
/status_pages/{subdomain}/webhooks/{webhookId}
Authorizations
AuthorizationstringRequired
Path parameters
subdomainstringRequired

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).

webhookIdintegerRequired

The ID of a webhook

Responses
200

The webhook

application/json
get/status_pages/{subdomain}/webhooks/{webhookId}
GET /api/v2/status_pages/{subdomain}/webhooks/{webhookId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*
{
  "webhook": {
    "url": "url",
    "events": [
      "incident.created",
      "incident.updated"
    ],
    "enabled": true
  }
}

Update the webhook

put
/status_pages/{subdomain}/webhooks/{webhookId}
Authorizations
AuthorizationstringRequired
Path parameters
subdomainstringRequired

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).

webhookIdintegerRequired

The ID of a webhook

Body
Responses
200

The webhook was updated

application/json
put/status_pages/{subdomain}/webhooks/{webhookId}
PUT /api/v2/status_pages/{subdomain}/webhooks/{webhookId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "webhook": {
    "url": "url",
    "events": [
      "incident.created",
      "incident.updated"
    ],
    "enabled": true
  }
}
{
  "webhook": {
    "url": "url",
    "events": [
      "incident.created",
      "incident.updated"
    ],
    "enabled": true
  }
}

Deletes the webhook

delete
/status_pages/{subdomain}/webhooks/{webhookId}
Authorizations
AuthorizationstringRequired
Path parameters
subdomainstringRequired

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).

webhookIdintegerRequired

The ID of a webhook

Responses
204

Webhook deleted successfully

delete/status_pages/{subdomain}/webhooks/{webhookId}
DELETE /api/v2/status_pages/{subdomain}/webhooks/{webhookId} HTTP/1.1
Host: statuspal.io
Authorization: YOUR_API_KEY
Accept: */*

No content

Last updated