Overview
The Slack connector for Bizagi is available for download at Bizagi Connectors Xchange.
Through this connector, you will be able to connect your Bizagi processes to a www.slack.com account in order to use Slack chat services.
For more information about this connector's capabilities, visit Bizagi Connectors Xchange.
Before you start
In order to test and use this connector, you will need:
1.Bizagi Studio previously installed.
2.This connector previously installed, via the Connectors Xchange as described at https://help.bizagi.com/platform/en/index.html?Connectors_Xchange.htm, or through a manual installation as described at https://help.bizagi.com/platform/en/index.html?Connectors_install.htm.
3.A workspace at www.slack.com.
4.Browse https://api.slack.com/docs/token-types and check which of the token types work best for you. We recommend you to use User tokens since they let you work directly on behalf of users.
5.Go to https://api.slack.com/apps and create an app on Slack.
6.Fill out all the prompted details and click Create app.
7.Go to OAuth & Permissions.
8.If it is a User app, enable the following scopes.
9.If it is a Workspace app, enable the following scopes.
10. Click Install app to workspace.
11. Copy and keep the token to use it on the Connector’s configuration on Bizagi.
Configuring the connector
In order to configure the connector (i.e its authentication parameters), follow the steps presented at the Configuration chapter in https://help.bizagi.com/platform/en/index.html?connectors_setup.htm.
For this configuration, consider the following authentication parameters:
•Authentication method: Custom.
•Token: The token obtained as per the previous procedure. It lets you use the API Services over your app.
Using the connector
This connector features a set of available methods of Slack’s API services.
To learn overall how/where to configure the use of a connector, refer to https://help.bizagi.com/platform/en/index.html?Connectors_Studio.htm.
When using the connector, make sure you consider the following details for each of the available methods.
Complete reminder
Mark a reminder as complete.
To configure its inputs, consider:
•Reminder: ID of the reminder you wish to mark as complete. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Delete reminder
Deletes an existent reminder.
To configure its inputs, consider:
•Reminder: ID of the reminder you wish to delete. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Create reminder
Creates a new reminder.
To configure its inputs, consider:
•Text: Content of the reminder. This parameter is required for a successful service invocation.
•Time: When the reminder should happen expressed in Unix timestamp format. This parameter is required for a successful service invocation.
•User: ID of the user who will receive the reminder.
To configure its outputs consider mapping:
Get reminder list
Obtain a list of reminders.
To configure its outputs consider mapping:
Get conversation messages
Get the messages of a conversation
To configure its inputs, consider:
•Channel: ID of the channel from which you wish to get the messages from. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Get conversation members
Obtain a list of the users of a specific conversation.
To configure its inputs, consider:
•Channel: ID of the channel from which you wish to get the list of users from. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Unarchive conversation
Reverses a conversation’s archival.
To configure its inputs, consider:
•Channel: ID of the channel you wish to unarchive. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Archive conversation
Archive a conversation.
To configure its inputs, consider:
•Channel: ID of the channel you wish to archive. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Create conversation
Create a public or private channel.
To configure its inputs, consider:
•Name: Name of the channel (only lowercase letters allowed). This parameter is required for a successful service invocation.
•User_ids: IDs of the users to be included in the new channel separated by commas.
•Is_private: Boolean value indicating whether the channel is private.
To configure its outputs consider mapping:
Get list of internal conversations
Obtain all the internal conversations.
To configure its outputs consider mapping:
Get list of multipart internal conversations
Obtain all multipart internal conversations
To configure its outputs consider mapping:
Get list of private conversations
Obtain all private conversations
To configure its outputs consider mapping:
Get list of public conversations
Obtain all public conversations
To configure its outputs consider mapping:
Invite users to conversation
Invite users to a specific conversation.
To configure its inputs, consider:
•Channel: ID of the channel where the users are being ivited. This parameter is required for a successful service invocation.
•User_ids: IDs of the users to be invited to the conversation separated by commas. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Rename conversation
Change the name of a conversation.
To configure its inputs, consider:
•Channel: ID of the channel whose name you want to change. This parameter is required for a successful service invocation.
•Name: New name for the specified conversation (Only receives lowercase letters). This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Set conversation purpose
Establish a purpose to a specific conversation.
To configure its inputs, consider:
•Channel: ID of the channel whose purpose you wish to set. This parameter is required for a successful service invocation.
•Purpose: New purpose for the specified conversation. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Set conversation topic
Establish a topic for a specific conversation.
To configure its inputs, consider:
•Channel: ID of the channel whose topic you wish to set. This parameter is required for a successful service invocation.
•Topic: New topic for the specified conversation. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Delete file
Deletes a file.
To configure its inputs, consider:
•File: ID of the file you want to delete. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Get file list
Obtain the list of files.
To configure its inputs, consider:
•Channel: ID of the channel whose file you wish to obtain. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Upload file
Upload a file to multiple channels.
To configure its inputs, consider:
•Channels: IDs of the channels to which you wish to add the file to, provide them separated by commas. This parameter is required for a successful service invocation.
•filename: File name of the attachment This parameter is required for a successful service invocation.
•file: Base64 file to upload. This parameter is required for a successful service invocation.
•title: Title of the file.
•token: If provided, the file is added on behalf of the user instead of the application.
To configure its outputs consider mapping:
Delete message
Deletes a message.
To configure its inputs, consider:
•Channel: ID of the channel where the message you want to delete was sent. This parameter is required for a successful service invocation.
•TS: Timestamp of the message you wish to delete. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Get conversation messages
Get the messages of a conversation.
To configure its inputs, consider:
•Channel: ID of the channel from which you wish to obtain the messages. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Send message
Send a message to a public or private channel, on a direct conversation or IM channel.
To configure its inputs, consider:
•Channel: ID of the channel to which you wish to send the message. This parameter is required for a successful service invocation.
•message: Text of the message you wish to send. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Update message
Edit a message that has been sent to a channel.
To configure its inputs, consider:
•Channel: ID of the channel where the message you wish to update was sent to. This parameter is required for a successful service invocation.
•ts: Timestamp of the message you want to edit. This parameter is required for a successful service invocation.
•text: New text to be posted instead of the original message. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Get user by email
Obtain a user by its email address.
To configure its inputs, consider:
•email: email of the user you wish to retrieve. This parameter is required for a successful service invocation.
To configure its outputs consider mapping:
Get users list
Obtain the list of users.
To configure its outputs consider mapping:
For more information about this method, refer to Slack's API official documentation at https://api.slack.com/methods.
Last Updated 10/27/2022 2:25:15 PM