Verwalten Sie Help-Center-Integrationen mit der Notiondesk API

Die Notiondesk API ermöglicht es Ihnen, die Drittanbieterintegrationen Ihres Hilfecenters aufzulisten, zu konfigurieren und zu deaktivieren: Anbieter von Analysediensten, Live-Chat und Tag-Managern. Verwenden Sie sie, um dieselbe Analyse- oder Chat-Konfiguration in mehreren Hilfecentern mit einem einzigen Skript bereitzustellen.

Das Konfigurieren und Deaktivieren von Anbietern erfordert einen Plan, der Integrationen beinhaltet.

Jeder Anbieter lädt ein Drittanbieter-Skript auf jeder Seite Ihres Hilfecenters. Ein Google Tag Manager-Container führt die vom Inhaber veröffentlichten Inhalte aus, und Plausible oder Umami legen fest, woher das Analyse-Skript geladen wird. Daher ist es wichtig, den Umfang von Änderungen an Integrationen festzulegen. Vergeben Sie einen Schlüssel nur an Integrationen, denen Sie vertrauen.proxy_urladminadmin

Unterstützte Anbieter

Jeder Wert ist eine Zeichenkette mit bis zu 255 Zeichen. Keiner davon ist geheim: Jeder Wert ist eine Kennung, die das Skript des Anbieters auf der Seite benötigt. Notiondesk prüft das Format, aber nicht die ID selbst, beim Anbieter.

Listen Sie Ihre Integrationen auf

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
}

Die Liste enthält deaktivierte Anbieter in keiner bestimmten Reihenfolge und passt immer in eine Antwort. Anbieter, die nie konfiguriert wurden, fehlen.

Konfigurieren Sie einen Anbieter

Sende die Felder des Anbieters an seinen Pfad. Die Route antwortet mit 200 OK auf die Integration.

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
}

• Ein Update aktiviert den Provider immer. Es gibt kein Feld enabled: Um einen Provider zu deaktivieren, verwenden Sie die Deaktivierungsroute.

• Ein Feld, das Sie auslassen, behält seinen gespeicherten Wert. Um einen konfigurierten Provider wieder zu aktivieren, ohne ihn zu ändern, senden Sie {}.

• Um einen Proxy zu entfernen, senden Sie "proxy_url": null.

• Bei jedem Update wird das gesamte Hilfecenter aktualisiert, wobei die zwischengespeicherten Seiten gelöscht und jede Seite neu aufgebaut wird.

Hinweis: Werte, die vor Anwendung der aktuellen Formate gespeichert wurden, wie z. B. eine Google Analytics-ID oder ein Wert, der nicht dem Standardwert entspricht, können nicht validiert werden. Solange Sie keinen gültigen Wert für dieses Feld senden, wird jede Aktualisierung dieses Anbieters mit dem Statuscode 400 beantwortet.UA-proxy_urlhttpsvalidation_error{}

Einen Anbieter deaktivieren

Die Route antwortet mit 204 No Content, und Ihr Hilfecenter lädt den Anbieter nicht mehr. Dessen Einstellungen bleiben erhalten, daher wird er weiterhin in der Liste mit enabled: false angezeigt. Durch Senden von {} an die zugehörige Aktualisierungsroute wird er wieder aktiviert.

Das Deaktivieren eines Anbieters, der bereits deaktiviert ist oder nie konfiguriert wurde, beantwortet ebenfalls 204 und ändert nichts, daher ist ein erneuter Versuch immer sicher.

Fehler

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"

Siehe Handle Notiondesk API errors, rate limits, and retries für den Fehlerumschlag und die anderen Codes.

Häufig gestellte Fragen

Was kommt als Nächstes?

• Erhalten Sie Analysen zum Hilfecenter mit der Notiondesk API.

• Passen Sie das Branding und die Designs des Hilfecenters mit der Notiondesk API an.

• Authentifizieren Sie sich mit der Notiondesk API mithilfe der API-Schlüssel.