Widget reference

Webhook widget: volledige instelling reference

Webhook widget maakt dashboard-acties mogelijk via HTTP requests, inclusief parameterbinding, authenticatie en custom headers.

Core request Parameters Authenticatie Headers

1. Core instellingen

Webhook widget settings — Webhook editor met request, params, auth en header secties.

Defaults

method=POST.
buttonLabel=Run webhook, buttonIcon=pi pi-bolt, buttonSeverity=info.
refreshAfterRun=false.
Standaard een lege parameterregel in de editor.

Key	Type	Beschrijving
`webhookId`	string	Optionele technische ID voor tracing/logica.
`url`	string	Target endpoint.
`method`	GET/POST/PUT/PATCH/DELETE	HTTP methode.
`buttonLabel`	string	Tekst op knop.
`buttonIcon`	string	PrimeIcon class.
`buttonSeverity`	primary/secondary/success/info/warn/help/danger/contrast	PrimeNG button stijl.
`refreshAfterRun`	boolean	Herlaad dashboarddata na succesvolle run.

2. Param schema

Param key	Waarden	Uitleg
`key`	string	Parameternaam in request payload/query.
`mode`	`static`, `filter`	Statische waarde of uit dashboardfilter halen.
`value`	string	Statische waarde bij mode static.
`filterKey`	string	Filterbron bij mode filter.
`adjustable`	boolean	Parameter mag door gebruiker aangepast worden in UI (static mode).
`inputType`	`input`, `text`, `html`	Inputcontrol voor adjustable waarde.

Validatie

Lege paramregels worden genegeerd bij opslaan.
Mode filter zonder filterKey wordt niet meegenomen.
De editor bewaart alleen valide en complete paramobjecten.

3. Authenticatie schema

Auth type	Keys	Gebruik
`none`	-	Geen auth headers.
`basic`	`username`, `password`	HTTP Basic auth.
`bearer`	`token`	Authorization Bearer token.
`api-key`	`headerName`, `headerValue`	Custom API key header.
`oauth2-client`	`tokenUrl`, `clientId`, `clientSecret`, `scope`, `audience`, `extraParams`	Client-credentials token flow.

4. Headers en payload merge

Onderdeel	Schema	Notities
`headers[]`	array van `{ key, value }`	Extra request headers.
`auth.extraParams[]`	array van `{ key, value }`	Extra token request params bij OAuth client flow.

Opslaggedrag

Lege headers worden verwijderd bij save.
Auth wordt alleen opgeslagen als type niet none of als velden gevuld zijn.
Widget options kunnen minimaal zijn; alleen ingevulde keys worden bewaard.

5. Voorbeeld webhook options JSON

{
  "webhookId": "notify_management",
  "url": "https://api.example.com/notify",
  "method": "POST",
  "buttonLabel": "Verstuur update",
  "buttonIcon": "pi pi-send",
  "buttonSeverity": "primary",
  "params": [
    { "key": "country", "mode": "filter", "filterKey": "country" },
    { "key": "message", "mode": "static", "value": "Automatische update", "adjustable": true, "inputType": "text" }
  ],
  "auth": {
    "type": "bearer",
    "token": "{{runtime_token}}"
  },
  "headers": [
    { "key": "X-Tenant", "value": "tenant_a" }
  ],
  "refreshAfterRun": true
}