Unsere Website gibt es auch auf Deutsch - w├╝rden Sie gerne zu dieser Version wechseln?Zu Deutsch wechseln

Stackfield API

With the Stackfield API, you have the ability to send data from your systems directly to Stackfield to automate your internal processes.

Description

With the incoming WebHooks, information can be forwarded directly to Stackfield without much detour. This interface uses HTTP requests in combination with JSON payloads to create elemtens, such as messages, tasks, etc., on Stackfield.

To send data to a Stackfield, POST URLs must be generated.

Where do I get the POST URL?

Sending data to a Room

The POST URL for sending data to a Room can be accessed through the Room Settings. There you can find the tab "Integrations", in which the button "Add new WebHook" can be selected.

Changing the Room Settings

Likewise in the Room Settings, tab "Integrations", there is the Room API ID, via which the room settings can be controlled.
(This feature is only available in the Enterprise version!)

Changing the Organization Settings

Within the Organization Settings is the tab "Integrations" located, which allows the administration of all interfaces to the organization. This tab also includes the option "WebHook". After clicking on "More", the necessary options for adding new WebHooks to control the Organization Settings are displayed.
(This feature is only available in the Enterprise version!)

Limitations

A maximum of one request per second can be processed.

Availability

In addition to sending information to Stackfield, it is also possible to make changes to the settings of the rooms and the organization. The editing of the settings via API is only available in the Enterprise version.

Error Codes

Error Code Description
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 Messages

Location of the POST URL
Room Settings > Integrations > Add a new WebHook > Chat Message
Parameter
Parameter Mandatory field Description
Title Yes Content of the Chat Message
Type
POST Content-Type: "application/json"
Example
curl -X POST -H 'Content-Type: application/json' -d '{"Title":"Hello World!"}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Discussions

Location of the POST URL
Room Settings > Integrations > Add a new WebHook > Discussion
Parameter
Parameter Mandatory field Description
TitleYesTitle of the Discussion
ContentNoDescription of the Discussion
Type
POST Content-Type: "application/json"
Example
curl -X POST -H 'Content-Type: application/json' -d '{"Title":"That's a title!", "Content":"Look at that description!"}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Tasks

Location of the POST URL
Room Settings > Integrations > Add a new WebHook > Task
Parameter
Parameter Mandatory field Description
TitleYesTitle of the Task
ContentNoDescription of the Task
DateStartNoStart date
DateEndNoEnd date
UsersNoList of email addresses of assigned users
Type
POST Content-Type: "application/json"
Example
curl -X POST -H 'Content-Type: application/json' -d '{"Title":"That's a title!", "Content":"Look at that description!", "DateStart":"2019-07-08 22:00", "Users":["user1@demo.de","user2@demo.de"]}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Documents

Location of the POST URL
Room Settings > Integrations > Add a new WebHook > Document
Parameter
Parameter Mandatory field Description
TitleYesTitle of the Document
ContentNoDescription of the Document
Type
POST Content-Type: "application/json"
Example
curl -X POST -H 'Content-Type: application/json' -d '{"Title":"That's a title!", "Content":"Look at that description!"}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Events

Location of the POST URL
Room Settings > Integrations > Add a new WebHook > Event
Parameter
Parameter Mandatory field Description
TitleYesTitle of the Event
ContentNoDescription of the Event
DateStartYesStart date
DateEndYesEnd date
UsersNoList of invited users
Type
POST Content-Type: "application/json"
Example
curl -X POST -H 'Content-Type: application/json' -d '{"Title":"That's a title!", "Content":"Look at that description!", "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

Files

Location of the POST URL
Room Settings > Integrations > Add a new WebHook > File
Parameter
Parameter Mandatory field Description
FileYesFile path
Type
POST Content-Type: "multipart/form-data"
Example
curl -F 'File=@C:\Pictures\MyImage.jpg' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Adding Users to the Organization

POST Url
Organization Settings > Integrations > WebHook > Add a new WebHook > User
Parameter
Parameter Mandatory field Description
CommandYesCommand name: CreateUser
EmailYesEmail address of the user
DisplayNameYesDisplay name of the user
UserNameOnly for Windows Authentication (On-Premise-Version)UserId
OrgRoleIdYesRole within the Organization:
1 - Admin
2 - Member
3 - Guest
4 - External
Type
POST Content-Type: "application/json"
Example
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

Removing User from the Organization

Location of the POST URL
Organization Settings > Integrations > WebHook > Add a new WebHook
Parameter
Parameter Mandatory field Description
CommandYesCommand name: RemoveUser
EmailYesEmail address of the User
Type
POST Content-Type: "application/json"
Example
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

Deactivating Users

Location of the POST URL
Organization Settings > Integrations > WebHook > Add a new WebHook
Parameter
Parameter Mandatory field Description
CommandYesBefehlsname: DeactivateUser
EmailYesEmail address of the User
Type
POST Content-Type: "application/json"
Example
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

Creating Rooms

Location of the POST URL
Organization Settings > Integrations > WebHook > Add a new WebHook
Parameter
Parameter Mandatory field Description
CommandYesCommand name: CreateRoom
RoomId(Return)Id of the Room
NameYesName of the Room
DescriptionNeinDescription of the Room
TemplateIdNeinId of the Room Template
UsersNeinList of Room Members
Type
POST Content-Type: "application/json"
Example
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

Archiving Rooms

Location of the POST URL
Organization Settings > Integrations > WebHook > Add a new WebHook > Room Settings
Parameter
Parameter Mandatory field Description
CommandYesCommand name: ArchiveRoom
Type
POST Content-Type: "application/json"
Example
curl -X POST -H 'Content-Type: application/json' -d '{"Command":"ArchiveRoom"}' https://www.stackfield.com/apiwh/e5a1cfbd-970e-45a1-b81c-3e004f9bdab5

Adding Users to a Room

Location of the POST URL
Organization Settings > Integrations > WebHook > Add a new WebHook > Room Settings
Room Settings > Integrations > WebHook > Add a new WebHook > Room Settings
Parameter
Parameter Mandatory field Description
CommandYesCommand name: GrantRoomAccess
UsersYesList of Room Members
RoomIdNoRaum API Id
Type
POST Content-Type: "application/json"
Example
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

Removing Users from a Room

Location of the POST URL
Organization Settings > Integrations > WebHook > Add a new WebHook > Room Settings
Room Settings > Integrations > WebHook > Add a new WebHook > Room Settings
Parameter
Parameter Mandatory field Description
CommandYesCommand name: RevokeRoomAccess
UsersYesList of Room Members
RoomIdNoRaum API Id
Type
POST Content-Type: "application/json"
Example
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
This site uses cookies to give you the best possible experience. By surfing on our site, you agree to the use of cookies. Learn more
OK
Ready to try Stackfield?
Over 10.000 companies joined Stackfield
Try Stackfield for free