Oznámení přes webhook

Přidání odběratele přes webhook

Přihlaste se do Instatusu na instatus.com/login a vyberte svou stavovou stránku.

Přejděte do Odběratelé a pak na Webhook.

Klikněte na Přidat odběratele přes webhook,

Objeví se nový formulář, kde zadáte:

• URL webhooku
• E-mailovou adresu

Na vaši URL budeme posílat požadavky v tomto formátu a když s URL nastane problém, přijde na zadanou e-mailovou adresu e-mail.

Odběrateli přes webhook můžete dát název — klikněte na něj a napište název do formuláře. Stejně tak ho můžete smazat kliknutím na Zrušit odběr.

Ověření payloadu webhooku

Důrazně doporučujeme payload webhooku na endpointu ověřovat.

Payloady webhooků podepisujeme tajným klíčem a podpis přikládáme v hlavičce x-instatus-webhook-signature. Díky němu si ověříte, že webhook opravdu přišel z Instatusu.

Postup ověření webhooku

1. Získejte v dashboardu svůj tajný klíč webhooku (najdete ho při vytváření nebo úpravě webhooku a můžete si ho tam i změnit).

2. Vytvořte na svém serveru nový endpoint, který bude webhook přijímat.

3. Porovnejte podpis s podpisem vygenerovaným na vašem serveru.

4. Když podpisy sedí, webhook zpracujte.

Ukázka kódu

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

Proč na ověřování záleží

• Zaručuje pravost: Máte jistotu, že webhook pochází z naší platformy.
• Odhalí manipulaci: Pozná, že se payload změnil.
• Zvyšuje bezpečnost: Chrání před replay útoky a neoprávněným přístupem.