Beheer integraties met het helpcentrum via de Notiondesk API

Met de Notiondesk API kunt u de integraties van derden met uw helpcentrum, zoals analyse-, livechat- en tagmanagementproviders, weergeven, configureren en uitschakelen. Gebruik de API om dezelfde analyse- of chatconfiguratie in één script voor meerdere helpcentra uit te rollen.

Het configureren en uitschakelen van providers vereist een plan dat integraties omvat.

Elke provider laadt een script van een derde partij op elke pagina van uw helpcentrum. Een Google Tag Manager-container voert alles uit wat de eigenaar publiceert, en Plausible of Umami bepaalt waar het analysescript vandaan wordt geladen. Daarom is het belangrijk om integraties te wijzigen. Geef alleen een sleutel aan integraties die u vertrouwt.proxy_urladminadmin

Ondersteunde aanbieders

Elke waarde is een tekenreeks van maximaal 255 tekens. Geen van deze waarden is geheim: elke waarde is een identificatiecode die het script van de provider nodig heeft op de pagina. Notiondesk controleert het formaat, maar niet de ID zelf, bij de provider.

Geef een overzicht van uw integraties

curl "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

{
  "object": "list",
  "data": [
    {
      "type": "plausible-analytics",
      "settings": {"domain": "help.example.com", "proxy_url": null},
      "enabled": true
    },
    {
      "type": "crisp",
      "settings": {"app_id": "7d1c9a2e-5b4f-4e3a-9c8d-2f1e0a9b8c7d"},
      "enabled": false
    }
  ],
  "has_more": false,
  "next_cursor": null
}

De lijst bevat uitgeschakelde providers, in willekeurige volgorde, en past altijd in één antwoord. Een provider die nooit geconfigureerd is, ontbreekt.

Een provider configureren

Stuur de velden van de provider naar het bijbehorende pad. De route antwoordt met 200 OK met de integratie.

curl -X PATCH "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/plausible-analytics" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16" \
  -H "Content-Type: application/json" \
  -d '{"domain": "help.example.com"}'

{
  "type": "plausible-analytics",
  "settings": {"domain": "help.example.com", "proxy_url": null},
  "enabled": true
}

• Een update schakelt de provider altijd in. Er is geen enabled veld: om een ​​provider uit te schakelen, gebruik je de disable route.

• Een veld dat u weglaat, behoudt de opgeslagen waarde. Om een ​​geconfigureerde provider weer in te schakelen zonder deze te wijzigen, stuurt u {}.

• Om een ​​proxy te verwijderen, stuur "proxy_url": null.

• Elke update vernieuwt het hele helpcentrum, waarbij de pagina's in de cache worden gewist en elke pagina opnieuw wordt opgebouwd.

Let op: Een waarde die is opgeslagen voordat de huidige formaten werden toegepast, zoals een Google Analytics-ID of een waarde die niet leeg is, wordt niet gevalideerd. Totdat u een geldige waarde voor dat veld verzendt, geeft elke update van die provider een 400-foutmelding, inclusief.UA-proxy_urlhttpsvalidation_error{}

Een provider uitschakelen

De route geeft als antwoord 204 No Content en uw helpcentrum stopt met het laden van de provider. De instellingen blijven behouden, dus de lijst toont deze nog steeds met enabled: false, en {} dat naar de updateroute wordt gestuurd, schakelt deze weer in.

Het uitschakelen van een provider die al uitgeschakeld is, of een provider die nooit geconfigureerd is, geeft ook de foutmelding 204 en verandert niets, dus een nieuwe poging is altijd veilig.

Fouten

curl -i -X POST "https://api.notiondesk.so/sites/c74781f6-1aea-4e17-ab23-bbb8b4d174b6/integrations/google-tag-manager/disable" \
  -H "Authorization: Bearer $NOTIONDESK_API_KEY" \
  -H "nd-version: 2026-10-16"

Zie 'API-fouten, snelheidslimieten en herhaalpogingen afhandelen' voor de foutomvang en de andere codes.

Veelgestelde vragen

Wat volgt?

• Krijg inzicht in de resultaten van het helpcentrum met de Notiondesk API.

• Personaliseer de huisstijl en thema's van het helpcentrum met de Notiondesk API

• Authenticeer bij de Notiondesk API met behulp van API-sleutels.