Note: There is a newer version (0.8.0) of this package available. Click here to view docs for the latest version.
Module trigger.slack
ballerinax/trigger.slack Ballerina library
0.6.3
Overview
The ballerinax/trigger.slack module provides a Listener to grasp events triggered from your Slack App. This functionality is provided by Slack Events API.
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Slack account.
- Subscribe to events and obtain verification token
- Visit https://api.slack.com/apps, create your own Slack App and enable Event Subscription by going to
Event Subscriptionssection in your Slack App. - Add events that you are planning to listen in the
Subscribe to events on behalf of userssection and save changes. - Obtain
Verification Tokenfrom theBasic Informationsection of your Slack App.
- Visit https://api.slack.com/apps, create your own Slack App and enable Event Subscription by going to
Quickstart
To use the Slack listener in your Ballerina application, update the .bal file as follows:
Step 1: Import listener
Import the ballerinax/trigger.slack module as shown below.
import ballerinax/trigger.slack;
Step 2: Create a new listener instance
Create a slack:Listener using your Slack Verification Token, port and initialize the listener with it.
slack:ListenerConfig configuration = { verificationToken: "VERIFICATION_TOKEN" }; listener slack:Listener slackListener = new (configuration);
Step 3: Implement a listener remote function
- Now you can implement a listener remote function supported by this connector.
-
Write a remote function to receive a particular event type. Implement your logic within that function as shown in the below sample.
-
Following is a simple sample for using Slack listener
import ballerina/log; import ballerinax/trigger.slack; listener slack:Listener slackListener = new (verificationToken); service slack:UserChangeService on slackListener { isolated remote function onUserChange(slack:GenericEventWrapper event) returns error? { log:printInfo("New Message"); } }
- Use
bal runcommand to compile and run the Ballerina program.
-
Register the request URL
- Run your ballerina service (similar to above sample) on prefered port.
- Start ngrok on same port using the command
./ngrok http 9090 - In
Event Subscriptionssection of your Slack App settings, paste the URL issued by ngrok following with your service path (eg :https://365fc542d344.ngrok.io/slack/events/) ('/slack/events/'should be added after thr ngrok URL. Even if it's not an ngrok URL, trailing / at the end of the URL is mandatory). - Slack Event API will send a url_verification event containing the token and challenge key value pairs.
- Slack Listener will automatically verify the URL by comparing the token and send the required response back to slack
- Check whether your request URL displayed as
verifiedinEvent Subscriptionssection of your Slack App. - Subscribe to the events that you are planning to listen and click
Save Changesbutton.
-
Receiving events
- After successful verification of Request URL your ballerina service will receive events.
Listeners
trigger.slack: Listener
attach
Isolated Function
function attach(GenericServiceType serviceRef, () attachPoint) returns error?detach
Isolated Function
function detach(GenericServiceType serviceRef) returns error?Parameters
- serviceRef GenericServiceType -
'start
Isolated Function
function 'start() returns error?gracefulStop
Isolated Function
function gracefulStop() returns error?immediateStop
Isolated Function
function immediateStop() returns error?Records
trigger.slack: GenericEventWrapper
Fields
- event_id string - A unique identifier for this specific event, globally unique across all workspaces.
- api_app_id string - The unique identifier your installed Slack application.
- team_id string - The unique identifier of the workspace where the event occurred
- 'type string - Indicates which kind of event dispatch this is, usually
event_callback
- event_time int - The epoch timestamp in seconds indicating when this event was dispatched.
- token string - A verification token to validate the event originated from Slack
trigger.slack: ListenerConfig
Fields
- verificationToken string - The token which is used in the delivery verification process
trigger.slack: Message
Fields
- authed_users string[] -
- event_id string -
- api_app_id string - Your Slack app's unique ID
- team_id string - The unique identifier of the team/workspace where the event happened
- event record { deleted_ts string, hidden boolean, previous_message record { file record { preview anydata, filetype string, title string, ims anydata[], mode string, url_private string, id string, state string, display_as_bot boolean, timestamp int, editor string, created int, editable boolean, last_editor string, groups anydata[], is_external boolean, pretty_type string, external_type string, url_private_download string, permalink_public string, channels string[], size int, comments_count int, is_public boolean, name string, mimetype string, permalink string, public_url_shared boolean, updated int, user string, username string }, subtype string, comment anydata, text string, 'type string, ts string }, subtype string, event_ts string, 'channel string, 'type string, ts string } -
- 'type string -
- event_time int -
- token string - Verification token used to validate the origin of the event
Object types
trigger.slack: SlackEventsAppService
onAppMention
Remote Function
function onAppMention(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onAppRateLimited
Remote Function
function onAppRateLimited(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onAppUninstalled
Remote Function
function onAppUninstalled(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsChannelService
onChannelArchive
Remote Function
function onChannelArchive(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onChannelCreated
Remote Function
function onChannelCreated(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onChannelDeleted
Remote Function
function onChannelDeleted(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onChannelHistoryChanged
Remote Function
function onChannelHistoryChanged(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onChannelLeft
Remote Function
function onChannelLeft(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onChannelRename
Remote Function
function onChannelRename(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onChannelUnarchive
Remote Function
function onChannelUnarchive(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsDndService
onDndUpdated
Remote Function
function onDndUpdated(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onDndUpdatedUser
Remote Function
function onDndUpdatedUser(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsEmailDomainChangedService
onEmailDomainChanged
Remote Function
function onEmailDomainChanged(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsEmojiChangedService
onEmojiChanged
Remote Function
function onEmojiChanged(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsFileService
onFileChange
Remote Function
function onFileChange(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onFileCommentAdded
Remote Function
function onFileCommentAdded(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onFileCommentDeleted
Remote Function
function onFileCommentDeleted(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onFileCommentEdited
Remote Function
function onFileCommentEdited(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onFileCreated
Remote Function
function onFileCreated(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onFileDeleted
Remote Function
function onFileDeleted(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onFilePublic
Remote Function
function onFilePublic(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onFileShared
Remote Function
function onFileShared(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onFileUnshared
Remote Function
function onFileUnshared(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsGridMigrationService
onGridMigrationFinished
Remote Function
function onGridMigrationFinished(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onGridMigrationStarted
Remote Function
function onGridMigrationStarted(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsGroupService
onGroupArchive
Remote Function
function onGroupArchive(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onGroupClose
Remote Function
function onGroupClose(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onGroupHistoryChanged
Remote Function
function onGroupHistoryChanged(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onGroupLeft
Remote Function
function onGroupLeft(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onGroupOpen
Remote Function
function onGroupOpen(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onGroupRename
Remote Function
function onGroupRename(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onGroupUnarchive
Remote Function
function onGroupUnarchive(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsImService
onImClose
Remote Function
function onImClose(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onImCreated
Remote Function
function onImCreated(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onImHistoryChanged
Remote Function
function onImHistoryChanged(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onImOpen
Remote Function
function onImOpen(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsLinkSharedService
onLinkShared
Remote Function
function onLinkShared(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsMemberService
onMemberJoinedChannel
Remote Function
function onMemberJoinedChannel(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onMemberLeftChannel
Remote Function
function onMemberLeftChannel(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsMessageService
onMessage
Remote Function
Parameters
- payload Message -
onMessageAppHome
Remote Function
function onMessageAppHome(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onMessageChannels
Remote Function
function onMessageChannels(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onMessageGroups
Remote Function
function onMessageGroups(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onMessageIm
Remote Function
function onMessageIm(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onMessageMpim
Remote Function
function onMessageMpim(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsPinService
onPinAdded
Remote Function
function onPinAdded(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onPinRemoved
Remote Function
function onPinRemoved(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsReactionService
onReactionAdded
Remote Function
function onReactionAdded(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onReactionRemoved
Remote Function
function onReactionRemoved(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsResourcesService
onResourcesAdded
Remote Function
function onResourcesAdded(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onResourcesRemoved
Remote Function
function onResourcesRemoved(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsScopeService
onScopeDenied
Remote Function
function onScopeDenied(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onScopeGranted
Remote Function
function onScopeGranted(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsStarService
onStarAdded
Remote Function
function onStarAdded(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onStarRemoved
Remote Function
function onStarRemoved(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsSubteamService
onSubteamCreated
Remote Function
function onSubteamCreated(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onSubteamMembersChanged
Remote Function
function onSubteamMembersChanged(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onSubteamSelfAdded
Remote Function
function onSubteamSelfAdded(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onSubteamSelfRemoved
Remote Function
function onSubteamSelfRemoved(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onSubteamUpdated
Remote Function
function onSubteamUpdated(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsTeamService
onTeamDomainChange
Remote Function
function onTeamDomainChange(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onTeamJoin
Remote Function
function onTeamJoin(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
onTeamRename
Remote Function
function onTeamRename(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsTokensRevokedService
onTokensRevoked
Remote Function
function onTokensRevoked(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsUrlVerificationService
onUrlVerification
Remote Function
function onUrlVerification(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
trigger.slack: SlackEventsUserChangeService
onUserChange
Remote Function
function onUserChange(GenericEventWrapper payload) returns error?Parameters
- payload GenericEventWrapper -
Union types
trigger.slack: GenericDataType
GenericDataType
trigger.slack: GenericServiceType
GenericServiceType