flowground for Business Customers

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

getConversations

Gets a list of conversations and communities the authenticated user participates in.

OnInit
./lib/actions/getConversations.js
OnStartup
-
OnClose
-

Attributes

-

getCommunityConversations

Gets a list of communities. This endpoint can be used to explore the communities the authenticated user could join.

OnInit
./lib/actions/getCommunityConversations.js
OnStartup
-
OnClose
-

Attributes

-

createCommunityConversation

Creates a community. Communities are open conversations that anyone in a Circuit domain (tenant) can join without having to be added by another user.

OnInit
./lib/actions/createCommunityConversation.js
OnStartup
-
OnClose
-

Attributes

-

updateConversationCommunity

Updates the information of the given community.

OnInit
./lib/actions/updateConversationCommunity.js
OnStartup
-
OnClose
-

Attributes

-

joinCommunityConversation

Adds the authenticated user to the given community (i.e., allows the user to join this community). Contrary to the operation of adding a new participant, this operation can only be performed by a user who is not yet a member of the community.

OnInit
./lib/actions/joinCommunityConversation.js
OnStartup
-
OnClose
-

Attributes

-

removeParticipantCommunity

Removes one or more participants from the given community. The last participant of a community cannot be removed. This operation can only be performed by a user who is already a member of the community.

OnInit
./lib/actions/removeParticipantCommunity.js
OnStartup
-
OnClose
-

Attributes

-

addParticipantCommunity

Adds one or more participants to the given community. This operation can only be performed by a user who is already a member of the community.

OnInit
./lib/actions/addParticipantCommunity.js
OnStartup
-
OnClose
-

Attributes

-

getDirectConversation

Checks if a 1-to-1 conversation between the authenticated user and the user with the provided userId exists.

OnInit
./lib/actions/getDirectConversation.js
OnStartup
-
OnClose
-

Attributes

-

createDirectConversation

Creates a 1-to-1 conversation between the authenticated user and the user with the provided userId. In case there is already an existing 1-to-1 conversation between these users, the endpoint returns the existing conversation.

OnInit
./lib/actions/createDirectConversation.js
OnStartup
-
OnClose
-

Attributes

-

getFavoriteConversations

Gets the conversationIds which are marked as favorites.

OnInit
./lib/actions/getFavoriteConversations.js
OnStartup
-
OnClose
-

Attributes

-

createGroupConversation

Creates a group conversation between three or more users. The authenticated user is directly added to this conversation.

OnInit
./lib/actions/createGroupConversation.js
OnStartup
-
OnClose
-

Attributes

-

updateConversationGroup

Updates the information of the given group conversation.

OnInit
./lib/actions/updateConversationGroup.js
OnStartup
-
OnClose
-

Attributes

-

removeParticipantGroup

Removes one or more participants from the given group conversation. The last participant of a group conversation cannot be removed. This operation can only be performed on behalf of a user who is already a member of the conversation.

OnInit
./lib/actions/removeParticipantGroup.js
OnStartup
-
OnClose
-

Attributes

-

addParticipantGroup

Adds one or more participants to the given group conversation. This operation can only be performed by a user who is already a member of the conversation.

OnInit
./lib/actions/addParticipantGroup.js
OnStartup
-
OnClose
-

Attributes

-

getConversationsByLabel

Returns conversations with matching labels and paginated

OnInit
./lib/actions/getConversationsByLabel.js
OnStartup
-
OnClose
-

Attributes

-

getFlagItemConv

Gets a list of all the messages the authenticated user has flagged. This endpoint should be used carefully in case where the authenticated user has a lot of flagged messages.

OnInit
./lib/actions/getFlagItemConv.js
OnStartup
-
OnClose
-

Attributes

-

getSingleConversationtem

Returns a text item for a given item id

OnInit
./lib/actions/getSingleConversationtem.js
OnStartup
-
OnClose
-

Attributes

-

moderateConversation

Set a conversation in moderatd mode. Moderators can be added and removed

OnInit
./lib/actions/moderateConversation.js
OnStartup
-
OnClose
-

Attributes

-

resolveInvitationToken

Resolves an invite token to a conversation

OnInit
./lib/actions/resolveInvitationToken.js
OnStartup
-
OnClose
-

Attributes

-

searchConversations

Performs a search for conversation content. A maximum of 100 conversations is returned. If you hit this limit you should refine the search term.

OnInit
./lib/actions/searchConversations.js
OnStartup
-
OnClose
-

Attributes

-

unmoderateConversation

Set a conversation to unmoderatd mode

OnInit
./lib/actions/unmoderateConversation.js
OnStartup
-
OnClose
-

Attributes

-

getConversationbyId

Gets a conversation based on the given ID.

OnInit
./lib/actions/getConversationbyId.js
OnStartup
-
OnClose
-

Attributes

-

getJoinDetails

Gets the conference details of the given conversation. Conference details include the URL, which is used to join the conference through a web or mobile application, as well as the dial-in phone numbers and conference PIN, which are used to join the conference by phone.

OnInit
./lib/actions/getJoinDetails.js
OnStartup
-
OnClose
-

Attributes

-

deleteFavorite

Removes a conversation from favorites. Favorites can be displayed in a separate side tab inside of the Circuit client to have a better overview of important conversations.

OnInit
./lib/actions/deleteFavorite.js
OnStartup
-
OnClose
-

Attributes

-

addFavorite

Adds a conversation to the favorites. Favorites can be displayed in a separate side tab inside of the Circuit client to have a better overview of important conversations.

OnInit
./lib/actions/addFavorite.js
OnStartup
-
OnClose
-

Attributes

-

getConversationItems

Gets a list of conversation items.

OnInit
./lib/actions/getConversationItems.js
OnStartup
-
OnClose
-

Attributes

-

assignLabel

Adds a label to a conversation, you can search and organize your conversations based on these labels

OnInit
./lib/actions/assignLabel.js
OnStartup
-
OnClose
-

Attributes

-

unassignLabel

Removes a label from a conversation, you can search and organize your conversations based on these labels

OnInit
./lib/actions/unassignLabel.js
OnStartup
-
OnClose
-

Attributes

-

addTextItem

Adds a message to the given conversation. This operation can be only performed on behalf of a user who is already a member of the conversation.

OnInit
./lib/actions/addTextItem.js
OnStartup
-
OnClose
-

Attributes

-

getFlagItem

Gets a list of all the flagged messages in the given conversation.

OnInit
./lib/actions/getFlagItem.js
OnStartup
-
OnClose
-

Attributes

-

deleteTextItem

Marks a message in the given conversation as deleted. Deleted messages are still part of the conversation, but their content is no more visible. This operation can only be performed on behalf of the message's creator.

OnInit
./lib/actions/deleteTextItem.js
OnStartup
-
OnClose
-

Attributes

-

addTextItemWithParent

Adds a message to the existing item. The added message will be a child item of the message with the given itemId.

OnInit
./lib/actions/addTextItemWithParent.js
OnStartup
-
OnClose
-

Attributes

-

updateTextItem

Updates the content or subject of the existing message. Only the creator of the message is allowed to perform this operation.

OnInit
./lib/actions/updateTextItem.js
OnStartup
-
OnClose
-

Attributes

-

unFlagItem

Removes the flag from a given message that is posted to the given conversation.

OnInit
./lib/actions/unFlagItem.js
OnStartup
-
OnClose
-

Attributes

-

flagItem

Adds a flag to the given message in the given conversation.

OnInit
./lib/actions/flagItem.js
OnStartup
-
OnClose
-

Attributes

-

unlikeItem

Removes a "like" from the given message in the given conversation

OnInit
./lib/actions/unlikeItem.js
OnStartup
-
OnClose
-

Attributes

-

likeItem

Adds a "like" to the given message in the given conversation

OnInit
./lib/actions/likeItem.js
OnStartup
-
OnClose
-

Attributes

-

removeModerators

Removes a list of moderators from a conversation

OnInit
./lib/actions/removeModerators.js
OnStartup
-
OnClose
-

Attributes

-

addModerators

Adds a list of moderators to a conversation

OnInit
./lib/actions/addModerators.js
OnStartup
-
OnClose
-

Attributes

-

getParticipantsByConvId

Performs a search for participants. The max number of participants is configurable. If more participants are available a search pointer is returned for consecutive calls.

OnInit
./lib/actions/getParticipantsByConvId.js
OnStartup
-
OnClose
-

Attributes

-

getPinnedConversations

Returns pinned topics of a conversation

OnInit
./lib/actions/getPinnedConversations.js
OnStartup
-
OnClose
-

Attributes

-

unPinAConversation

OnInit
./lib/actions/unPinAConversation.js
OnStartup
-
OnClose
-

Attributes

-

pinAConversation

OnInit
./lib/actions/pinAConversation.js
OnStartup
-
OnClose
-

Attributes

-

oAuthGetClientIds

Gets a list of the client IDs (applications) that were created for this user.

OnInit
./lib/actions/oAuthGetClientIds.js
OnStartup
-
OnClose
-

Attributes

-

oAuthGetScopeList

Gets a list of available OAuth scopes

OnInit
./lib/actions/oAuthGetScopeList.js
OnStartup
-
OnClose
-

Attributes

-

oAuthValidateAccessToken

Gets the access token for the given token ID.

OnInit
./lib/actions/oAuthValidateAccessToken.js
OnStartup
-
OnClose
-

Attributes

-

getActiveSessions

Gets a list of active RTCsessions

OnInit
./lib/actions/getActiveSessions.js
OnStartup
-
OnClose
-

Attributes

-

searchUser

Search for users based on an email address or username

OnInit
./lib/actions/searchUser.js
OnStartup
-
OnClose
-

Attributes

-

getLabel

Returns all labels of the user that were defined either explicit or implicit via assignment to conversations.

OnInit
./lib/actions/getLabel.js
OnStartup
-
OnClose
-

Attributes

-

addLabel

Add a label to the list of user labels

OnInit
./lib/actions/addLabel.js
OnStartup
-
OnClose
-

Attributes

-

removeLabel

Remove a label from the list of user labels

OnInit
./lib/actions/removeLabel.js
OnStartup
-
OnClose
-

Attributes

-

searchUsersList

Search multiple users given by id or email address.

OnInit
./lib/actions/searchUsersList.js
OnStartup
-
OnClose
-

Attributes

-

getPresence

Gets the presence status of the users whose IDs or email addresses are given.

OnInit
./lib/actions/getPresence.js
OnStartup
-
OnClose
-

Attributes

-

setUserPresence

Updates the presence status of the authenticated user.

OnInit
./lib/actions/setUserPresence.js
OnStartup
-
OnClose
-

Attributes

-

getProfile

Gets the authenticated user's profile information.

OnInit
./lib/actions/getProfile.js
OnStartup
-
OnClose
-

Attributes

-

updateProfile

Updates the user profile of the authenticated user

OnInit
./lib/actions/updateProfile.js
OnStartup
-
OnClose
-

Attributes

-

getUserById

Gets the profile information of the user with the given ID.

OnInit
./lib/actions/getUserById.js
OnStartup
-
OnClose
-

Attributes

-

getUserPresence

Gets the presence status of the users whose ID or email address is given.

OnInit
./lib/actions/getUserPresence.js
OnStartup
-
OnClose
-

Attributes

-

removeWebHooks

Unregisters all webHooks of the authenticated user

OnInit
./lib/actions/removeWebHooks.js
OnStartup
-
OnClose
-

Attributes

-

getWebHook

Gets the list of webHooks registered for this user or API.

OnInit
./lib/actions/getWebHook.js
OnStartup
-
OnClose
-

Attributes

-

addWebHook

Registers the webHook with the given filter and callback URL.

OnInit
./lib/actions/addWebHook.js
OnStartup
-
OnClose
-

Attributes

-

createIncomingWebhook

Create a new webhook. Conversation must exist and creater has to be participant.

OnInit
./lib/actions/createIncomingWebhook.js
OnStartup
-
OnClose
-

Attributes

-

getIncomingWebhookByUser

Get all webhooks of a special user.

OnInit
./lib/actions/getIncomingWebhookByUser.js
OnStartup
-
OnClose
-

Attributes

-

deleteIncomingWebhook

Delete a new webhook. Webhook must exist

OnInit
./lib/actions/deleteIncomingWebhook.js
OnStartup
-
OnClose
-

Attributes

-

postWebhookAsSlackMessage

Post text items to conversations via slack apps.

OnInit
./lib/actions/postWebhookAsSlackMessage.js
OnStartup
-
OnClose
-

Attributes

-

addPresenceWebHook

Registers a webHook that has a presence filter with the given URL and userIds. There is a maximum number of userIds allowed

OnInit
./lib/actions/addPresenceWebHook.js
OnStartup
-
OnClose
-

Attributes

-

updatePresenceWebHook

Updates a registration of a webHook that has a presence filter. The update can be performed either on the URL and/or the userIds. The new userIds, if any, will override any existing userIds.

OnInit
./lib/actions/updatePresenceWebHook.js
OnStartup
-
OnClose
-

Attributes

-

removeWebHook

Unregisters the webHook with the given ID.

OnInit
./lib/actions/removeWebHook.js
OnStartup
-
OnClose
-

Attributes

-

getWebHookById

Gets the registered webHook with the given ID.

OnInit
./lib/actions/getWebHookById.js
OnStartup
-
OnClose
-

Attributes

-

updateWebHook

Updates a webHook registration with the given filter and callback URL.

OnInit
./lib/actions/updateWebHook.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

OAUTH_CLIENT_ID

OAuth Client ID

type
-
required
-
example
-

OAUTH_CLIENT_SECRET

OAuth Client Secret

type
-
required
-
example
-