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

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.

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",
  "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

Parameter

{
  "endpoint": "string",
  "title": "string",
  "description": "string",
  "author": "string",
  "enabled": true,
  "objects": {
    "ids": [
      "string"
    ],
    "type": "string"
  },
  "watchActivites": [
    "string"
  ],
  "watchChildTypes": [
    "string"
  ],
  "watchChildActivities": [
    "string"
  ],
  "watchChildActivitiesEnabled": false,
  ]
}
JSON
ParameterOptional?Mögliche WerteBeschreibung
endpointPflichtStringURL des Webhook-Endpunkts
titlePflichtStringBezeichnung der Webhook-Konfiguration
descriptionOptionalStringBeschreibung der Webhook-Konfiguration
authorPflichtStringBenutzer, der als Autor dient
enabledPflichtBooleanDe-/Aktiviert die Webhook-Konfiguration
objectsOptional
Enthält Objekte, die beobachtet werden sollen
  • ids
PflichtString

IDs der zu beobachtenden Objekte

Bei type=global wird die ID 1 verwendet.

  • type
Pflichtglobal, projects, boards, cards, lists, swimlanes, users

Objekttyp der zu beobachtenden Objekte, kann nur einen Typ enthalten

Mit global werden alle Objekte im System beobachtet.

watchActivitiesOptionalString

Aktivitäten, die beobachtet werden sollen

Wird hier nichts definiert, werden alle Aktivitäten beobachtet

watchChildTypesOptionalString

Kindobjekttypen, die beobachtet werden sollen

Wird hier nichts definiert, werden alle Kindobjekte beobachtet

watchChildActivitiesOptionalString

Aktivitäten von Kindobjekten, die beobachtet werden sollen

Wird hier nichts definiert, werden alle Aktivitäten beobachtet

watchChildActivitiesEnabledOptionalBooleanErmöglicht das Beobachten von untergeordneten Aktivitäten

Objekttypen

ObjektKindobjekte
GlobalProjects, Boards, Swimlanes, Lists, Cards, Checklists, Comments, Workloads, Attachments
ProjectsBoards, Swimlanes, Lists, Cards, Checklists, Comments, Workloads, Attachments
BoardsSwimlanes, Lists, Cards, Checklists, Comments, Workloads, Attachments
Swimlanes / ListsCards, Checklists, Comments, Workloads, Attachments
CardsChecklists, Comments, Workloads, Attachments
Users/

Aktivitätentypen

ParameterTypBeschreibung
watchChildActivities

addProject Hinzufügen eines Projekts
Weitere Aktivitäten der Kindobjekte
ParameterTypBeschreibung

watchActivities













updateProjectTitle

Ändern der Projektbezeichnung
updateProjectDescriptionÄndern der Projektbeschreibung
updateProjectProjectKeyÄndern des Projektschlüssels
removeProjectDescriptionEntfernen der Projektbeschreibung
updateProjectDetailsÄndern der Detailbeschreibung des Projekts
removeProjectDetailsEntfernen der Detailbeschreibung des Projekts
updateProjectStartDateÄndern des Anfangsdatums des Projekts
updateProjectDueDateÄndern des Fälligkeitsdatums des Projekts
addProjectDueDateHinzufügen des Fälligkeitsdatums des Projekts
addProjectStartDateHinzufügen des Anfangsdatums des Projekts
deleteProjectDueDateEntfernen des Fälligkeitsdatums des Projekts
deleteProjectStartDateEntfernen des Anfangsdatums des Projekts

watchChildActivities


 

 

 

 

createBoard

Erstellen eines Boards

importBoard

Importieren eines Boards

copyBoard

Kopieren eines Boards

createBoardFromTemplate

Erstellen eines Boards aus einem Template

moveBoardTarget

Verschieben eines Boards in das Projekt
moveBoardSourceVerschieben eines Boards aus dem Projekt
Weitere Aktivitäten der Kindobjekte
ParameterTypBeschreibung
watchActivitiesdeleteBoardLöschen des Boards
removeBoardDescriptionEntfernen der Board-Beschreibung
updateBoardDescriptionÄndern der Board-Beschreibung

updateBoardTitle 

Ändern des Board-Titels

changeBoardPermissionÄndern der Board-Sichtbarkeit
addBoardStartDateHinzufügen des Anfangsdatums des Boards
updateBoardStartDateÄndern des Anfangsdatums des Boards
deleteBoardStartDateEntfernen des Anfangsdatums des Boards
addBoardDueDateHinzufügen des Fälligkeitsdatums des Boards
updateBoardDueDateÄndern des Fälligkeitsdatums des Boards
deleteBoardDueDateEntfernen des Fälligkeitsdatums des Boards
addBoardMemberHinzufügen von Board-Mitgliedern
removeBoardMemberEntfernen von Board-Mitgliedern
archivedBoardArchivieren eines Boards
restoredBoardWiederherstellen eines Boards
watchChildActivitieslinkBoardVerlinken eines Boards auf dem Board
linkCardVerlinken einer Karte auf dem Board
deleteLinkBoardEntfernen eines verlinkten Boards
deleteLinkCardEntfernen einer verlinkten Karte
createCustomFieldErstellen eines benutzerdefinierten Felds
createSwimlaneErstellen einer Swimlane
copySwimlaneKopieren einer Swimlane
createListErstellen einer Liste
importListImportieren einer Liste

copyList

Kopieren einer Liste

moveListSource

Verschieben einer Liste in das Board
moveListTargetVerschieben einer Liste auf das Board

createCard

Erstellen einer Karte
importCardImportieren einer Karte
copyCardKopieren einer Karte
moveCardTargetVerschieben einer Karte auf das Board
moveCardSourceVerschieben einer Karte aus dem Board
Weitere Aktivitäten der Kindobjekte
ParameterTypBeschreibung
watchActivitiesarchivedListArchivieren einer Liste
restoredListWiederherstellen einer Liste

deleteList

Löschen einer Liste

renameList

Umbenennen einer Liste
watchChildActivities

Aktivitäten der Kindobjekte


ParameterTypBeschreibung
watchActivitiesarchivedSwimlaneArchivieren einer Swimlane
restoredSwimlaneWiederherstellen einer Swimlane
deleteSwimlaneLöschen einer Swimlane
renameSwimlaneUmbenennen einer Swimlane
watchChildActivities

Aktivitäten der Kindobjekte


ParameterTypBeschreibung
watchActivitiesarchivedCardArchivieren einer Karte
restoredCardWiederherstellen einer Karte
deleteCardLöschen einer Karte
moveCardVerschieben einer Karte innerhalb des Boards
setDueDateHinzufügen des Fälligkeitsdatums der Karte
setStartDateHinzufügen des Anfangsdatums der Karte
unsetDueDateEntfernen des Fälligkeitsdatums der Karte
unsetStartDateEntfernen des Anfangsdatums der Karte
updateDueDateÄndern des Fälligkeitsdatums der Karte
updateStartDateÄndern des Anfangsdatums der Karte
addedLabelHinzufügen eines Labels
removedLabelEntfernen eines Labels
updateCardTitleÄndern des Kartentitels
updateCardDescriptionÄndern der Kartenbeschreibung
removeCardDescriptionEntfernen der Kartenbeschreibung
joinMemberHinzufügen eines Kartenmitglieds
unjoinMemberEntfernen eines Kartenmitglieds
completedCardMarkieren der Karte als "Erledigt"
reopenedCardEntfernen des "Erledigt"-Status
setCustomFieldWählen des Werts eines benutzerdefinierten Felds auf der Karte
unsetCustomFieldEntfernen des Werts eines benutzerdefinierten Felds auf der Karte
assignCustomFieldHinzufügen eines benutzerdefinierten Felds zur Karte
unassignCustomFieldEntfernen eines benutzerdefinierten Felds von der Karte
voteAddHinzufügen einer Stimme beim benutzerdefinierten Feld "Abstimmung"
watchChildActivitiesaddChecklistHinzufügen einer Checkliste
addChecklistItemHinzufügen eines Checklisten-Punkts
addCommentHinzufügen eines Kommentars
addWorkloadHinzufügen einer Zeiterfassung
setChecklistItemFinishedMarkieren eines Checklisten-Punkts als "Erledigt"
unsetChecklistItemFinishedEntfernen des "Erledigt"-Status eines Checklisten-Punkts
removeChecklistEntfernen einer Checkliste
removeChecklistItemEntfernen eines Checklisten-Punkts

renameChecklist

Umbenennen einer Checkliste

renameChecklistItem

Umbenennen eines Checklisten-Punkts
addAttachmentHinzufügen eines Anhangs
renameAttachmentUmbenennen eines Anhangs
removeAttachmentEntfernen eines Anhangs
updatedCloudAttachmentÄndern eines OneDrive-Anhangs