Powiadomienia webhook

Dodaj subskrybenta webhook

Zaloguj się do Instatus na instatus.com/login, a następnie wybierz swoją stronę statusu.

Przejdź do Subskrybenci, a potem do Webhook.

Kliknij Add webhook subscriber.

Pojawi się nowy formularz, w którym możesz podać:

• URL webhooka
• Adres e-mail

Będziemy wysyłać żądania na Twój adres URL w tym formacie, a w razie problemu z adresem URL wyślemy wiadomość na wskazany adres e-mail.

Subskrybentowi webhook możesz nadać nazwę, klikając go i wpisując nazwę w formularzu. Subskrybenta możesz też usunąć, klikając Unsubscribe.

Weryfikacja ładunku webhooka

Zdecydowanie zalecamy weryfikowanie ładunku webhooka w endpoincie webhooka.

Ładunki webhooków podpisujemy sekretem i dołączamy podpis w nagłówku o nazwie x-instatus-webhook-signature. Podpis pozwala zweryfikować, że webhook pochodzi z Instatus.

Kroki weryfikacji webhooka

1. Pobierz swój Webhook Secret z panelu (znajdziesz go podczas edycji lub tworzenia webhooka; tam też możesz go zmienić).

2. Utwórz na swoim serwerze nowy endpoint, który będzie odbierał webhook.

3. Porównaj podpis z podpisem wygenerowanym przez Twój serwer, aby go zweryfikować.

4. Jeśli podpisy się zgadzają, przetwórz webhook.

Przykład kodu

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

Dlaczego weryfikacja ma znaczenie

• Potwierdza autentyczność: Daje pewność, że webhook pochodzi z naszej platformy.
• Wykrywa manipulacje: Sygnalizuje zmiany w ładunku.
• Zwiększa bezpieczeństwo: Chroni przed atakami powtórzeniowymi i nieautoryzowanym dostępem.