Webhook-format

Her er formatet på webhookene du får hvis du har abonnert via webhooks:

Når en hendelse legges til eller oppdateres:

{
  "meta": {
    "unsubscribe": "",
    "documentation": ""
  },
  "page": {
    "id": "",
    "status_indicator": "",
    "status_description": "",
    "url": ""
  },
  "incident": {
    "backfilled": false,
    "created_at": "",
    "impact": "",
    "name": "",
    "resolved_at": "",
    "status": "",
    "updated_at": "",
    "id": "",
    "url": "",
    "incident_updates": [
      {
        "id": "",
        "incident_id": "",
        "body": "",
        "status": "",
        "created_at": "",
        "updated_at": ""
      }
    ]
  }
}

Når et vedlikehold legges til eller oppdateres:

{
  "meta": {
    "unsubscribe": "",
    "documentation": ""
  },
  "page": {
    "id": "",
    "status_indicator": "",
    "status_description": "",
    "url": ""
  },
  "maintenance": {
    "backfilled": false,
    "created_at": "",
    "impact": "",
    "name": "",
    "resolved_at": "",
    "status": "",
    "updated_at": "",
    "id": "",
    "url": "",
    "duration": "",
    "maintenance_updates": [
      {
        "id": "",
        "maintenance_id": "",
        "body": "",
        "status": "",
        "created_at": "",
        "updated_at": ""
      }
    ]
  }
}

Når en komponent oppdateres:

{
  "meta": {
    "unsubscribe": "https://<status-page-domain>/unsubscribe?id=${subscriber.id}&token=${subscriber.unsubscribeToken}",
    "documentation": ""
  },
  "page": {
    "id": "",
    "status_indicator": "",
    "status_description": "",
    "url": ""
  },
  "component_update": {
    "created_at": "",
    "new_status": "",
    "component_id": ""
  },
  "component": {
    "created_at": "",
    "id": "",
    "name": "",
    "status": ""
  }
}

Mulige statuser for statussiden:

UP
HASISSUES
UNDERMAINTENANCE

Mulige komponentstatuser:

OPERATIONAL
UNDERMAINTENANCE
DEGRADEDPERFORMANCE
PARTIALOUTAGE
MAJOROUTAGE

Mulige hendelsesstatuser:

INVESTIGATING
IDENTIFIED
MONITORING
RESOLVED

Mulige vedlikeholdsstatuser:

NOTSTARTEDYET
INPROGRESS
COMPLETED

Verifisering av webhook-nyttelast

Det anbefales sterkt å validere webhook-nyttelasten i webhook-endepunktet.

Vi signerer webhook-nyttelaster med en hemmelighet og inkluderer signaturen i en header med navnet x-instatus-webhook-signature. Denne signaturen lar deg verifisere at webhooken kom fra Instatus.

Trinn for å verifisere en webhook

Ta vare på webhook-hemmeligheten du genererte da du abonnerte på webhooken (du finner den når du abonnerer på en side via en webhook, og du kan også tilpasse den der).

Opprett et nytt endepunkt på serveren din som skal motta webhooken.
Sammenlign signaturen med signaturen serveren din genererer, for å validere.
Hvis signaturene stemmer overens, behandler du webhooken.

Kodeeksempel

import crypto from 'crypto'
import express from 'express'

const app = express()
app.use(express.json())

const WEBHOOK_SECRET = 'your-webhook-secret'

function isVerifiedPayload(payload, signature, secret) {
  const hmac = crypto.createHmac('sha256', secret)
  const digest = hmac.update(JSON.stringify(payload)).digest('hex')
  return crypto.timingSafeEqual(Buffer.from(digest), Buffer.from(signature))
}

app.post('/endpoint/to/webhook', (req, res) => {
  const payload = req.body
  const signature = req.header('x-instatus-webhook-signature')

  if (!signature) {
    return res.status(400).send('Signature missing')
  }

  if (!isVerifiedPayload(payload, signature, WEBHOOK_SECRET)) {
    return res.status(401).send('Invalid signature')
  }

  // Process the valid webhook
  res.status(200).send('Webhook received')
})

app.listen(3000, () => console.log('Server running on port 3000'))

Hvorfor verifisering er viktig

Sikrer autentisitet: Garanterer at webhooken kommer fra plattformen vår.
Hindrer manipulering: Oppdager endringer i nyttelasten.
Bedrer sikkerheten: Beskytter mot replay-angrep og uautorisert tilgang.