Naar hoofdinhoud gaan
Met webhooks stuurt het platform in realtime meldingen van events naar een systeem van jouw keuze. Telkens er een relevant event plaatsvindt, bijvoorbeeld een gebruiker die op een simulatielink klikt of een simulatie rapporteert, sturen we een HTTP POST-request met gestructureerde eventdata naar een URL die jij instelt. Zo koppel je het platform aan je eigen tooling, zoals een SIEM, een HR-systeem, een ticketsysteem of een eigen dashboard, zonder een API te moeten pollen.

​
Ondersteunde events

Al deze events worden naar je endpoint gestuurd. Je kunt je niet op een deel ervan abonneren.
Enkel de eerste keer dat een event zich voordoet, wordt het verstuurd. Klikt een gebruiker twee keer op dezelfde simulatie, dan krijg je één phishing.clicked-event. Botevents worden nooit verstuurd.

​
Voor je begint

Je hebt nodig:
  • Toegang tot het platform met de rol Administrator of Partner
  • Een publiek bereikbaar HTTPS-endpoint dat POST-requests kan ontvangen
Endpoints zonder TLS worden niet ondersteund. De URL moet https:// zijn.

​
Een webhook toevoegen

1

Open de webhookinstellingen

Ga naar Settings, dan Integrations en dan Webhooks.
2

Voeg de webhook toe

Klik op Add webhook en vul je endpoint-URL in. Dat moet een geldige, publiek bereikbare https://-URL zijn.
3

Bevestig

Klik op Add webhook om op te slaan.
4

Kopieer het signing secret

Er verschijnt een signing secret. Kopieer het meteen en klik daarna op I’ve copied the secret.
Het signing secret wordt één keer getoond en kan later niet meer opgevraagd worden. Bewaar het veilig voor je het venster sluit.
Om de integratie te testen, stuur je een testmail via Emails en dan Tests, en interageer je ermee.

​
Eventpayload

Events worden als JSON afgeleverd in de body van een HTTP POST-request. Voorbeeldpayload:

​
Echtheid controleren

Elke request bevat een X-Signature-header. Dat is een HMAC-SHA256-handtekening, berekend over de ruwe request-body met jouw signing secret als sleutel.
1

Lees de ruwe body

Neem de ruwe request-body, voor je de JSON parst.
2

Bereken de handtekening

Bereken HMAC-SHA256 over de ruwe body met je signing secret.
3

Vergelijk

Vergelijk je resultaat met de waarde in de X-Signature-header.
4

Aanvaard of weiger

Komen ze overeen, dan is de request echt en kun je ze verwerken. Komen ze niet overeen, weiger ze dan met een 401-respons.
Gebruik altijd een timing-safe vergelijkingsfunctie. Een gewone stringvergelijking lekt informatie via de uitvoeringstijd en kan gebruikt worden om een handtekening te vervalsen.

​
Nieuwe pogingen

Geeft je endpoint binnen 10 seconden geen HTTP 2xx-respons, dan wordt de aflevering automatisch opnieuw geprobeerd. Na 5 mislukte pogingen wordt de aflevering als Failed gemarkeerd.

​
Een webhook verwijderen

1

Open de webhookinstellingen

Ga naar Settings, dan Integrations en dan Webhooks.
2

Verwijder ze

Klik op Delete webhook en bevestig in het venster.
Een webhook verwijderen stopt alle verdere afleveringen. Events die plaatsvinden terwijl er geen webhook actief is, worden niet bewaard en ook niet achteraf alsnog afgeleverd.

​
Problemen oplossen

Voor alles wat hier niet vermeld staat, contacteer support@outkept.com met je organisatienaam en je endpoint-URL.