Zu Hauptinhalt springen
Our website is also available in English - would you like to switch to this version?Switch to the English version
MADE & HOSTED IN GERMANY
ISO 27001 ZERTIFIZIERT, BSI C5
DE
Anmelden Kostenlos testen Menu

Stackfield API

Mit der Stackfield API haben Sie die Möglichkeit Daten von Ihren Systemen aus direkt an Stackfield zu senden, um Ihre internen Prozesse zu automatisieren.
Allgemein Beschreibung Post URL Begrenzungen Verfügbarkeit Fehler Codes Daten Chat Nachricht Diskussion Aufgabe Seite Datei Termin Einstellungen Benutzer zur Organisation Benutzer aus Organisation Benutzer deaktivieren Raum erstellen Raum archivieren Benutzer zum Raum Benutzer aus Raum

Beschreibung

Einen Artikel mit Beispielen zur einfachen Nutzung der WebHooks mit externen Tools findest Du auf der folgenden Seite: https://www.stackfield.com/de/blog/automatisierte-prozesse-zapier-ifttt-86

Mit den eingehenden WebHooks können Informationen ohne große Umwege direkt an Stackfield weitergeleitet werden. Diese Schnittstelle nutzt HTTP-Anfragen in Verbindung mit JSON-Payloads, wodurch beispielsweise Nachrichten, Aufgaben o.ä. in Stackfield erstellt werden können.

Um Daten an Stackfield senden zu können müssen POST URLs generiert werden.

Wo bekommt man die POST URL?

Daten an einem Raum senden

Die POST URL zum Senden von Daten an einen Raum kann über die Raum-Einstellungen abgerufen werden. In den Einstellungen des Raumes befindet sich der Reiter "Integrationen", in welchem die Schaltfläche "Neuen WebHook hinzufügen" gewählt werden kann.

Raumeinstellungen ändern

Ebenso in den Raum-Einstellungen, Reiter "Integrationen", befindet sich die Raum API ID, über welche die Raum-Einstellungen gesteuert werden können.
(Diese Funktion steht nur in der Enterprise-Version zur Verfügung!)

Organisationseinstellungen ändern

Innerhalb der Organisations-Einstellungen befindet sich der Reiter "Integrationen", welcher die Verwaltung aller Schnittstellen zur Organisation ermöglicht. Hierbei wird auch die Option "WebHook" aufgeführt, wobei nach einem Klick auf "Mehr" die notwendigen Optionen zum Hinzufügen von neuen WebHooks zur Steuerung der Organisations-Einstellungen angezeigt werden.
(Diese Funktion steht nur in der Enterprise-Version zur Verfügung!)

Begrenzungen

Es kann maximal eine Anfrage pro Sekunde verarbeitet werden.

Verfügbarkeit

Neben der Weiterleitung von Informationen an Stackfield, ist es auch möglich Änderungen an den Einstellungen der Räume und der Organisation vorzunehmen. Die Bearbeitung der Einstellungen per API steht nur im Enterprise Paket zur Verfügung.

Fehlercodes

Errorcode Beschreibung
200Successful request and response.
4030Request could not be completed.
4031Invalid request.
4032Encrypted rooms are not supported.
4033Room type is not supported.
4034Invalid request.
4035List level: Module, Room or Organisation not active.
4035Invalid request. ObjectId is invalid.
4036Room level: Module, Room or Organisation not active.
4037Organisation level: Module, Room or Organisation not active.
4038Integration disabled.
4038Module disabled.
4039This organization is not a payed organization.
4040API call limit exceeded.
4041No files found.
4042File is too big. Max 1GB.
4042There is not enough free storage space in this organization to perform the upload.
4043Cannot read file.
4044Attachment could not be added.
4045Invalid file type.
4050Invalid request. Title is null or empty.
4051Invalid request. Users is null or empty.
4052Invalid request. Command is unknown.
4055Invalid request. DateEnd is before DateStart.
4056Invalid request. User contains invalid email.
4056Invalid request. Property could not be parsed.
4057Double request.
4060Invalid Email.
4061Invalid email. Item not found
4070Invalid request. Command is null or empty.
4071Invalid request. RoomId is null or empty.
4072Not enough free slots.
4073To many invitations
4074Users are managed by your domain.
4075Invalid request. User with email not member of this organization.
4076Invalid request. User with email is already deactivated.
4077Invalid request. You can not remove all admins.
4078Invalid email and group combination
4079Room is already archived
4080User is already member of this organization.
4081Setting: Rooms must be encrypted.
4082You can not use encrypted templates.

Chat Nachricht

Quelle der Post URL
Raumeinstellungen > Integrationen > Neuen Webhook hinzufügen > Chat Nachricht
Parameter
Parameter Pflichtfeld Beschreibung
Title Ja Inhalt der Chatnachricht
Type
POST Content-Type: "application/json"
Beispiel
curl -X POST -H 'Content-Type: application/json' -d '{"Title":"Hello World!"}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Diskussion

Quelle der Post URL
Raumeinstellungen > Integrationen > Neuen Webhook hinzufügen > Diskussion
Parameter
Parameter Pflichtfeld Beschreibung
TitleJaTitel der Diskussion
ContentNeinBeschreibung der Diskussion
Type
POST Content-Type: "application/json"
Beispiel
curl -X POST -H 'Content-Type: application/json' -d '{"Title":"Ich bin der Titel", "Content":"Ich bin eine Beschreibung"}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Aufgabe

Quelle der Post URL
Raumeinstellungen > Integrationen > Neuen Webhook hinzufügen > Aufgabe
Parameter
Parameter Pflichtfeld Beschreibung
TitleJaTitel der Aufgabe
ContentNeinBeschreibung der Aufgabe
DateStartNeinStartdatum
DateEndNeinEnddatum
UsersNeinListe der Email Adressen der zugewiesenen Personen
Type
POST Content-Type: "application/json"
Beispiel
curl -X POST -H 'Content-Type: application/json' -d '{"Title":"Ich bin der Titel", "Content":"Ich bin eine Beschreibung", "DateStart":"2019-07-08 22:00", "Users":["user1@demo.de","user2@demo.de"]}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Seite

Quelle der Post URL
Raumeinstellungen > Integrationen > Neuen Webhook hinzufügen > Seite
Parameter
Parameter Pflichtfeld Beschreibung
TitleJaTitel der Seite
ContentNeinBeschreibung der Seite
Type
POST Content-Type: "application/json"
Beispiel
curl -X POST -H 'Content-Type: application/json' -d '{"Title":"Ich bin der Titel", "Content":"Ich bin eine Beschreibung"}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Dateien

Quelle der Post URL
Raumeinstellungen > Integrationen > Neuen Webhook hinzufügen > Datei
Parameter
Parameter Pflichtfeld Beschreibung
FileJaDateipfad
Type
POST Content-Type: "multipart/form-data"
Beispiel
curl -F 'File=@C:\Pictures\MyImage.jpg' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Termin

Quelle der Post URL
Raumeinstellungen > Integrationen > Neuen Webhook hinzufügen > Termin
Parameter
Parameter Pflichtfeld Beschreibung
TitleJaTitel des Termins
ContentNeinBeschreibung des Termins
DateStartJaStartdatum
DateEndJaEnddatum
UsersNeinListe der eingeladenen Personen
Type
POST Content-Type: "application/json"
Beispiel
curl -X POST -H 'Content-Type: application/json' -d '{"Title":"Ich bin der Titel", "Content":"Ich bin eine Beschreibung", "DateStart":"2019-07-08 22:00","DateEnd":"2019-07-08 23:00", "Users":["user1@demo.de","user2@demo.de"]}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Benutzer zur Organisation hinzufügen

(Diese Funktion steht nur in der Enterprise-Version zur Verfügung!)

POST URL
Organisationseinstellungen > Integrationen > Webhook > Neuen Webhook hinzufügen
Parameter
Parameter Pflichtfeld Beschreibung
CommandJaBefehlsname: CreateUser
EmailJaEmail Adresse des Benutzers
DisplayNameJaAnzeigenamen des Benutzers
UserNameNur wenn Windows Authentifizierung (bei OnPremise)BenutzerId
OrgRoleIdJaRolle in Organisation:
1 - Admin
2 - Mitglied
3 - Gast
4 - Externer
AuthProviderNein (Nur bei SSO verwendet)Id des Identity Providers
Type
POST Content-Type: "application/json"
Beispiel
curl -X POST -H 'Content-Type: application/json' -d '{"Command":"CreateUser","Email":"apiTester01@webhook.de","DisplayName":"Api Tester01","OrgRoleId":2}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Benutzer aus Organisation entfernen

(Diese Funktion steht nur in der Enterprise-Version zur Verfügung!)

POST URL
Organisationseinstellungen > Integrationen > Webhook > Neuen Webhook hinzufügen
Parameter
Parameter Pflichtfeld Beschreibung
CommandJaBefehlsname: RemoveUser
EmailJaEmail Adresse des Benutzers
Type
POST Content-Type: "application/json"
Beispiel
curl -X POST -H 'Content-Type: application/json' -d '{"Command":"RemoveUser","Email":"apiTester01@webhook.de"}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Benutzer in Organisation deaktivieren

(Diese Funktion steht nur in der Enterprise-Version zur Verfügung!)

POST URL
Organisationseinstellungen > Integrationen > Webhook > Neuen Webhook hinzufügen
Parameter
Parameter Pflichtfeld Beschreibung
CommandJaBefehlsname: DeactivateUser
EmailJaEmail Adresse des Benutzers
Type
POST Content-Type: "application/json"
Beispiel
curl -X POST -H 'Content-Type: application/json' -d '{"Command":"DeactivateUser","Email":"apiTester01@webhook.de"}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Raum erstellen

(Diese Funktion steht nur in der Enterprise-Version zur Verfügung!)

POST URL
Organisationseinstellungen > Integrationen > Webhook > Neuen Webhook hinzufügen
Parameter
Parameter Pflichtfeld Beschreibung
CommandJaBefehlsname: CreateRoom
RoomId(Return)Id des Raumes
NameJaName des Raumes
DescriptionNeinBeschreibung des Raumes
TemplateIdNeinId des Raumtemplates
UsersNeinListe der Raummitglieder
Type
POST Content-Type: "application/json"
Beispiel
curl -X POST -H 'Content-Type: application/json' -d '{"Command":"CreateRoom","Name":"webhook room from template6","Description":"neuer webhook room desc","TemplateId":"03852566-669e-4991-9491-12', "Users":[{"Email":"remtester@mail.de","GroupId":2,"IsAdmin":"true"}]}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Raum archivieren

(Diese Funktion steht nur in der Enterprise-Version zur Verfügung!)

POST URL
Organisationseinstellungen > Integrationen > Webhook > Neuen Webhook hinzufügen > Raum Einstellungen
Parameter
Parameter Pflichtfeld Beschreibung
CommandJaBefehlsname: ArchiveRoom
Type
POST Content-Type: "application/json"
Beispiel
curl -X POST -H 'Content-Type: application/json' -d '{"Command":"ArchiveRoom"}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Benutzer zum Raum hinzufügen

(Diese Funktion steht nur in der Enterprise-Version zur Verfügung!)

POST URL
Organisationseinstellungen > Integrationen > Webhook > Neuen Webhook hinzufügen > Raum Einstellungen
Raum Einstellungen > Integrationen > WebHook > Neuen Webhook hinzufügen > Raum Einstellungen
Parameter
Parameter Pflichtfeld Beschreibung
CommandJaBefehlsname: GrantRoomAccess
UsersJaListe der Raummitglieder
RoomIdNeinRaum API Id
Type
POST Content-Type: "application/json"
Beispiel
curl -X POST -H 'Content-Type: application/json' -d '{"Command":"GrantRoomAccess", "Users":[{"Email":"remtester@mail.de","GroupId":2,"IsAdmin":"true"}]}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Benutzer aus Raum entfernen

(Diese Funktion steht nur in der Enterprise-Version zur Verfügung!)

POST URL
Organisationseinstellungen > Integrationen > Webhook > Neuen Webhook hinzufügen > Raum Einstellungen
Raum Einstellungen > Integrationen > WebHook > Neuen Webhook hinzufügen > Raum Einstellungen
Parameter
Parameter Pflichtfeld Beschreibung
CommandJaBefehlsname: RevokeRoomAccess
UsersJaListe der Raummitglieder
RoomIdNeinRaum API Id
Type
POST Content-Type: "application/json"
Beispiel
curl -X POST -H 'Content-Type: application/json' -d '{"Command":"RevokeRoomAccess","Users":["remtester@mail.te"]}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5
Bereit Stackfield zu testen?
Über 10.000 Unternehmen nutzen Stackfield
Kostenlos Stackfield testen