Formato dos webhooks

Estes são os formatos dos webhooks que você recebe se assinou por webhook:

Quando um incidente é adicionado ou atualizado:

{
  "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": ""
      }
    ]
  }
}

Quando uma manutenção é adicionada ou atualizada:

{
  "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": ""
      }
    ]
  }
}

Quando um componente é atualizado:

{
  "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": ""
  }
}

Status possíveis da página de status:

UP
HASISSUES
UNDERMAINTENANCE

Status possíveis do componente:

OPERATIONAL
UNDERMAINTENANCE
DEGRADEDPERFORMANCE
PARTIALOUTAGE
MAJOROUTAGE

Status possíveis do incidente:

INVESTIGATING
IDENTIFIED
MONITORING
RESOLVED

Status possíveis da manutenção:

NOTSTARTEDYET
INPROGRESS
COMPLETED

Verificação do payload do webhook

É altamente recomendável validar o payload do webhook no endpoint que o recebe.

Assinamos os payloads dos webhooks com um segredo e enviamos a assinatura em um cabeçalho chamado x-instatus-webhook-signature. Essa assinatura permite verificar que o webhook veio da Instatus.

Passos para verificar o webhook

Guarde o segredo do webhook que você gerou ao assinar o webhook (ele aparece quando você assina uma página por webhook, e lá também dá para personalizá-lo).

Crie um novo endpoint no seu servidor para receber o webhook.
Compare a assinatura recebida com a assinatura gerada pelo seu servidor para validar.
Se as assinaturas forem iguais, processe o webhook.

Exemplo de código

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

Por que a verificação importa

Garante autenticidade: assegura que o webhook veio da nossa plataforma.
Impede adulteração: detecta alterações no payload.
Aumenta a segurança: protege contra ataques de repetição e acessos não autorizados.