Przejdź do treści

Integracja webhook

Za pomocą webhooków możesz proaktywnie informować dowolne systemy o nadchodzących terminach odbioru odpadów – bez odpytywania. binable wysyła żądanie HTTP POST na Twój adres URL, gdy tylko odbiór przypada w skonfigurowanej liczbie dni.

Webhooki można tworzyć i usuwać bezpośrednio przez API. Przypadki użycia: automatyzacje n8n / Make, boty Discord lub Slack, wiadomości ntfy.sh, systemy automatyki domowej lub własne aplikacje.

1. Utwórz klucz API

Aby tworzyć webhooki, potrzebujesz najpierw klucza API. Zarejestruj swój adres e-mail, a otrzymasz klucz e-mailem.

Uzyskaj darmowy klucz API

2. Utwórz webhook

Wyślij żądanie POST na /api/webhook ze swoim kluczem API w nagłówku. Adres jest przekazywany bezpośrednio w treści żądania.

curl -X POST https://binable.app/api/webhook \
  -H "Authorization: ApiKey <dein-api-key>" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://mein-server.example/webhook",
    "daysBeforeCollection": 1,
    "street": "Musterstraße",
    "houseNumber": "1a",
    "zip": "12345",
    "city": "Musterstadt",
    "country": "DE"
  }'

Odpowiedź zawiera id i secret webhooka:

{
  "id": "018f1e2a-3b4c-7d5e-8f9a-0b1c2d3e4f56",
  "url": "https://mein-server.example/webhook",
  "secret": "a3f8b1c2d4e5...",
  "daysBeforeCollection": 1,
  "active": true
}
Secret jest zwracany tylko raz – przy tworzeniu webhooka. Przechowuj go bezpiecznie, potrzebujesz go do weryfikacji podpisu.

3. Payload i weryfikacja podpisu

binable wysyła POST do wszystkich aktywnych webhooków codziennie o godzinie 18:00, gdy odbiór przypada w skonfigurowanej liczbie dni:

{
  "event": "upcoming_collection",
  "sent_at": "2024-01-14T18:00:00+00:00",
  "days_until": 1,
  "address": {
    "street": "Musterstraße",
    "houseNumber": "1a",
    "zip": "12345",
    "city": "Musterstadt",
    "country": "DE"
  },
  "collections": [
    { "type": "Restmüll", "date": "2024-01-15" },
    { "type": "Papier",   "date": "2024-01-15" }
  ]
}

Każde żądanie zawiera nagłówek X-Muell-Signature: sha256=<hmac>. Weryfikacja w Node.js:

const crypto = require('crypto');

function verifySignature(body, secret, signatureHeader) {
  const expected = 'sha256=' + crypto
    .createHmac('sha256', secret)
    .update(body)
    .digest('hex');
  return crypto.timingSafeEqual(
    Buffer.from(expected),
    Buffer.from(signatureHeader)
  );
}

4. Usuń webhook

curl -X DELETE https://binable.app/api/webhook/018f1e2a-3b4c-7d5e-8f9a-0b1c2d3e4f56 \
  -H "Authorization: ApiKey <dein-api-key>"

Po pomyślnym wykonaniu serwer odpowiada kodem HTTP 204 (bez treści).

← Przegląd integracji  ·  Pełna dokumentacja API