Webhooks

Das Signaturgeheimnis ist nie enthalten. Es wird einmal bei der Anlage des Endpunkts gezeigt, und eine Endpunktliste, die es zurückgäbe, würde es jedem aushändigen, der diesen Aufruf lesen kann.

{
  "data": [
    {
      "id": "whk_1b7e6c19a139404cb173d23fcb3331c4",
      "url": "https://example.com/hooks/skautik",
      "events": ["property.created", "property.withdrawn"],
      "active": true,
      "created_at": "2026-08-13T10:43:37Z",
      "updated_at": "2026-08-13T10:43:37Z"
    }
  ]
}

https://api.skautik.com/v1/api/webhooks

Wird aus derselben Liste bedient, gegen die die API prüft, kann also nicht hinter dem zurückbleiben, was tatsächlich zustellbar ist.

{
  "data": [
    {
      "name": "property.created",
      "description": "A property was added to your organisation."
    }
  ]
}

https://api.skautik.com/v1/api/webhooks/events

Die Antwort enthält ein Signaturgeheimnis, einmalig gezeigt. Speichern Sie es sofort: Jede Zustellung wird damit signiert, und ein Handler, der die Signatur nicht prüft, nimmt gefälschte Aufrufe von jedem an, der die URL erfährt.

{
  "url": "https://example.com/hooks/skautik",
  "events": ["property.created", "property.withdrawn"]
}

{
  "data": {
    "webhook": {
      "id": "whk_1b7e6c19a139404cb173d23fcb3331c4",
      "url": "https://example.com/hooks/skautik",
      "events": ["property.created", "property.withdrawn"],
      "active": true,
      "created_at": "2026-08-13T10:43:37Z",
      "updated_at": "2026-08-13T10:43:37Z"
    },
    "secret": "whsec_uEw7ugUA3saVyNo087Sg3XvhBnWI0txICtik-ySKD2k"
  }
}

https://api.skautik.com/v1/api/webhooks

https://api.skautik.com/v1/api/webhooks/{webhook_id}

Eine Teiländerung: Was Sie weglassen, bleibt unangetastet. active auf false zu setzen beendet Zustellungen, ohne die Registrierung zu verlieren, und ist das, wonach man greift, während man einen Handler repariert.

{ "active": false }

https://api.skautik.com/v1/api/webhooks/{webhook_id}

Das, wonach man greift, wenn ein Geheimnis leckt. Das vorherige funktioniert in dem Moment nicht mehr, in dem dieser Aufruf zurückkommt, damit signierte Zustellungen scheitern also an der Prüfung: Rollen Sie das neue vorher aus, oder nehmen Sie eine Lücke in Kauf.

{
  "data": {
    "secret": "whsec_4_j7SxmfWXaoJnLbkypLXAw-Pjs8J74_OyWb-oj7fik",
    "note": "The previous secret stopped working immediately."
  }
}

https://api.skautik.com/v1/api/webhooks/{webhook_id}/rotate-secret

https://api.skautik.com/v1/api/webhooks/{webhook_id}

Sendet ein Ereignis webhook.test mit demselben Signatur- und Wiederholungsverhalten wie eine echte Zustellung, Sie können die Signaturprüfung also verifizieren, bevor etwas Echtes davon abhängt.

https://api.skautik.com/v1/api/webhooks/{webhook_id}/test

30 Tage lang vorgehalten. Die Stelle, an der man nachsieht, wenn ein Handler stillschweigend aufgehört hat zu arbeiten.

https://api.skautik.com/v1/api/webhooks/{webhook_id}/deliveries