Webhooks

Invece di fare polling, sottoscrivi gli eventi in uscita: Kinmu invia un POST al tuo endpoint HTTPS quando succede qualcosa di rilevante. Ogni consegna è firmata secondo la convenzione Standard Webhooks  — verifica sempre la firma prima di elaborare l’evento.

Sottoscrizione

Crea un endpoint indicando la tua URL (HTTPS) e gli eventi che ti interessano:

curl -s -X POST "https://api.kinmu.app/v1/webhook-endpoints" \
  -H "Authorization: Bearer kinmu_sk_live_…" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://tu-app.example.com/webhooks/kinmu",
    "events": ["absence.approved", "checkin.created"],
    "description": "Sync con nuestro ERP"
  }'

La risposta include il secret di firma (whsec_…), visibile una sola volta. Conservalo: ti serve per verificare le firme.

Gestione disponibile: GET (elenco), GET /{id}, PATCH /{id} (eventi/stato), DELETE /{id}, POST /{id}/test (invia un ping), GET /{id}/deliveries (ultime consegne) e POST /{id}/deliveries/{deliveryId}/retry (riaccoda una consegna specifica). Massimo 5 endpoint attivi per azienda.

Eventi

employee.created, employee.updated, employee.terminated, checkin.created, absence.requested, absence.approved, absence.denied, absence.cancelled, vacation_balance.updated, report.completed, ping.

Payload dell’evento

{ "id": "evt_…", "type": "absence.approved", "created_at": "…", "company_id": "…", "data": { … } }

data contiene id pubblici + stato (il minimo); quando ti servono tutti i campi, reidrata la risorsa completa con una GET.

Verifica della firma

Ogni consegna arriva con tre header:

Algoritmo: firma = base64( HMAC_SHA256( key, "{webhook-id}.{webhook-timestamp}.{body_raw}" ) ), con prefisso v1,. La key è la parte dopo whsec_ del secret (mostrato una sola volta alla creazione del webhook), decodificata da base64 a byte. La firma si calcola sul body raw (i byte esatti ricevuti), non sul JSON ri-serializzato.

Verifica (rifiuta se non coincide o se webhook-timestamp differisce di oltre 5 min dal tuo orologio):

const crypto = require('crypto');
 
function verify(secret, headers, rawBody) {
  const id = headers['webhook-id'];
  const ts = headers['webhook-timestamp'];
  if (Math.abs(Date.now() / 1000 - Number(ts)) > 300) return false; // ±5 min
 
  const key = Buffer.from(secret.replace(/^whsec_/, ''), 'base64');
  const expected = 'v1,' + crypto
    .createHmac('sha256', key)
    .update(`${id}.${ts}.${rawBody}`)
    .digest('base64');
 
  return headers['webhook-signature']
    .split(' ')
    .some(sig => crypto.timingSafeEqual(Buffer.from(sig), Buffer.from(expected)));
}

function verify(string $secret, array $headers, string $rawBody): bool {
    $id = $headers['webhook-id']; $ts = $headers['webhook-timestamp'];
    if (abs(time() - (int) $ts) > 300) return false; // ±5 min
    $key = base64_decode(preg_replace('/^whsec_/', '', $secret), true);
    $expected = 'v1,' . base64_encode(hash_hmac('sha256', "{$id}.{$ts}.{$rawBody}", $key, true));
    foreach (explode(' ', $headers['webhook-signature']) as $sig) {
        if (hash_equals($expected, $sig)) return true;
    }
    return false;
}

Retry

In caso di errore (o risposta ≠ 2xx) Kinmu riprova con backoff: 1 m, 5 m, 30 m, 2 h, 12 h, 24 h. Rispondi 2xx in fretta; se l’elaborazione è lenta, falla in async. Un endpoint che fallisce per 7 giorni di fila si disattiva automaticamente.

Puoi riaccodare manualmente una consegna fallita con POST /v1/webhook-endpoints/{id}/deliveries/{deliveryId}/retry (usa l’id della consegna che vedi in GET /{id}/deliveries).

Best practice