De Deployteq webhook biedt de mogelijkheid om data uit externe systemen te ontvangen. Bekijk onze documentatie voor het installeren en gebruik van de Webhook of volg de e-learning over Webhooks en Deployteq!

App token

Authenticatie voor de webhook kan op verschillende manieren. Bij het installeren van de webhook via de installation wizard krijg je bij stap 2 de vraag welke authenticatie methode je wil kiezen. Je kunt hier kiezen tussen Bearer Token en Basic Authentication. In beide gevallen geeft het aangemaakte token (of wachtwoord) je alleen toegang tot die specifieke webhook. Dit noemen we een App token.

Dit betekent dat als je meerdere webhooks aanmaakt, elke webhook een eigen token krijgt, die zijn gekoppeld aan het gebruikersaccount van diegene die de webhook heeft aangemaakt.

Integratietoken of API token

Wanneer je een integratie met meerdere webhooks maakt, kan het verstandig zijn om een token te gebruiken dat is gemaakt op een gebruiker, een integratietoken. Zo'n token kan worden gebruikt voor alle webhooks, wat het beheer van tokens veel eenvoudiger maakt.

Een gebruiker met toegang tot het gebruikersbeheer kan een nieuwe gebruiker met token aanmaken. De stappen worden uitgelegd in deze handleiding.

Wat gebeurt er als een account inactief is?

Een token (zowel App als API) is altijd gekoppeld aan een actief Deployteq gebruikersaccount.

Het kan voorkomen dat het gebruikersaccount waar de token aan gekoppeld zit inactief is geworden na 60 dagen geen activiteit, of dat de gebruiker uit dienst is en je het account wil verwijderen. In het eerste geval zal het bijbehorende token (of tokens) niet meer werken, en kan het niet meer gebruikt worden om die webhook te authenticeren. Je krijgt dan een 401 error op je webhook call.

Het betreffende account kan weer actief gemaakt worden door een gebruiker met toegang tot het gebruikersbeheer (lees hier meer over het opnieuw actief maken van een account). Het token wat aan het account gekopppeld zit kan daarna ook weer gebruikt worden om de webhook succesvol te authenticeren.

Mocht de gebruiker aan wie de tokens gekoppeld zitten uit dienst zijn, dan wil je waarschijnlijk het account verwijderen. Het systeem zal een waarschuwing geven als je een gebruiker probeert te verwijderen waar nog actieve tokens aan hangen. Het verwijderen is niet mogelijk zolang de tokens eraan hangen.

Je kan de gebruiker van wie het account is alvast de toegang tot het systeem ontzeggen door als beheerder het wachtwoord van het betreffende account te wijzigen. Het account blijft zo wel actief en de webhooks zullen zo ook blijven functioneren. Vervolgens kun je de oplossing zoals hieronder beschreven uitvoeren.

Oplossing

Om te voorkomen dat webhooks niet meer functioneren door inactieve gebruikersaccounts, raden we altijd aan om een apart gebruikersaccount aan te maken, wat niet gekoppeld is aan een persoon, en daar een API token op aan te maken.

Met dat account kun je vervolgens de webhooks inrichten.

Mocht je al in de situatie zitten dat een webhook niet meer functioneert door een inactieve gebruiker, dan is dat op te lossen door een nieuw token aan te maken op een ander gebruikersaccount, en dit nieuwe token in te zetten voor de bestaande webhook.

Let op: dit heeft ook impact op de systemen die verbinding maken met deze webhook, want daar zul je de token moeten aanpassen.