Webhooks

Informationen

PLANTA pulse bietet ausgehende Webhooks, mit denen Benutzer sich auf bestimmte Objekte und Ereignisse in PLANTA pulse registrieren können, um Updates zu diesen Aktivitäten zu erhalten.
Hierfür kann in PLANTA pulse eine Webhook-Konfiguration hinterlegt werden, die beim Eintreffen der gewünschten Ereignisse entsprechend reagiert und die Information an den Benutzer sendet.
- So können sich Benutzer beispielsweise zu allen Updates innerhalb eines Boards oder zu allen Aktivitäten eines Benutzers informieren lassen.

Ersteinrichtung

Webhooks aktivieren

Im Panel Administration → Tab Einstellungen → Menüeintrag API-Einstellungen die Checkbox Webhooks aktivieren aktivieren.
Ab sofort können Webhooks auf der PLANTA pulse REST-API konfiguriert werden.
Über die Checkbox Webhook-Debug-Logs ausgeben kann eingestellt werden, ob Debug-Logs für Webhooks ausgegeben werden.
- Wo die Logs ausgegeben werden, ist davon abhängig, wie der Logger konfiguriert ist.

Konfiguration

Informationen

Um bestimmte Ereignisse in PLANTA pulse zu abonnieren, können Konfigurationen für Webhooks hinterlegt werden.
- Hierbei besteht die Möglichkeit, einzelne oder mehrere Objekte zu beobachten und/oder deren untergeordnete Objekte (z. B. alle Karten innerhalb eines Boards).
- Dabei können entweder sämtliche Aktivitäten oder nur bestimmte Aktivitäten der Objekte beobachtet werden.
Webhook-Konfigurationen werden über die PLANTA pulse REST-API mit POST /api/webhooks angelegt.
Alternativ können Webhooks auch im Panel Administration → Webhooks angelegt und bearbeitet werden.

Beispiel: Webhook, der beobachtet, wann eine Liste umbenannt wird und wann neue Benutzer zu einer Karte innerhalb der Liste hinzugefügt werden

const webhookExample = {
  "endpoint": "https://example.url", // URL
  "title": "New Webhook",
  "description": "Watching a list",
  "language": "en",
  "format": "raw",
  "author": "username",
  "enabled": true, // you can turn off the webhook
  "objects": {
    "ids": [
      "jvNyPn3zThWwMBYR9", "...", // Object IDs to watch, no different types possible
    ],
    "type": "lists" // Object type
  },
  "watchActivities": [ // define activities to watch, don't add this if you want to watch any update
    "renameList" // only triggers when a list title is changed
  ],
  "watchChildActivitiesEnabled": true, // you can also turn off the child spectator
  "watchChildTypes": [
   "cards" // multiple types are allowed here
  ],
  "watchChildActivities": [
    "joinMember", "moveCard" // special acitvities to watch
  ]
};

JSON

Webhook im Panel Administration anlegen

Vorgehensweise

In das Panel Administration → Webhooks wechseln.
Auf klicken.
Eine Bezeichnung für den Webhook vergeben.
Bei Bedarf eine Beschreibung eingeben.
Den Endpunkt eintragen, an den der Webhook Informationen senden soll.
Ein Format auswählen.
- Generisch: unformatiert (Default)
- MS Teams: für Benachrichtigungen in Microsoft Teams optimiert
Den Typ des Objekts auswählen, das beobachtet werden soll.
Die Objekt-ID(s) der zubeobachtenden Objekte eintragen.
- Werden mehrere IDs eingegeben, diese mit Komma voneinander trennen.
Im Feld Zu beobachtende Aktivitäten eintragen, welche Aktivitäten beobachtet werden sollen.
- Wird nichts eingetragen, werden alle Aktivitäten des Objekts beobachtet.
Auswählen, ob die Aktivitäten der Kindelemente beobachtet werden sollen.
Bei Bedarf angeben, welche Kindelemente beobachtet werden sollen.
Bei Bedarf angeben, welche Aktivitäten der Kindelemente beobachtet werden sollen.

Parameter

{
  "endpoint": "string",
  "title": "string",
  "description": "string",
  "language": "string",
  "format": "string",
  "author": "string",
  "enabled": true,
  "objects": {
    "ids": [
      "string"
    ],
    "type": "string"
  },
  "watchActivites": [
    "string"
  ],
  "watchChildTypes": [
    "string"
  ],
  "watchChildActivities": [
    "string"
  ],
  "watchChildActivitiesEnabled": false,
  ]
}