Chapter 302. Slack Component
Available as of Camel version 2.16
The slack component allows you to connect to an instance of Slack and delivers a message contained in the message body via a pre established Slack incoming webhook.
Maven users will need to add the following dependency to their pom.xml
for this component:
302.1. URI format Copy linkLink copied to clipboard!
To send a message to a channel.
slack:#channel[?options]
slack:#channel[?options]
To send a direct message to a slackuser.
slack:@username[?options]
slack:@username[?options]
302.2. Options Copy linkLink copied to clipboard!
The Slack component supports 2 options which are listed below.
Name | Description | Default | Type |
---|---|---|---|
webhookUrl (producer) | The incoming webhook URL | String | |
resolveProperty Placeholders (advanced) | Whether the component should resolve property placeholders on itself when starting. Only properties which are of String type can use property placeholders. | true | boolean |
The Slack endpoint is configured using URI syntax:
slack:channel
slack:channel
with the following path and query parameters:
302.2.1. Path Parameters (1 parameters): Copy linkLink copied to clipboard!
Name | Description | Default | Type |
---|---|---|---|
channel | Required The channel name (syntax name) or slackuser (syntax userName) to send a message directly to an user. | String |
302.2.2. Query Parameters (5 parameters): Copy linkLink copied to clipboard!
Name | Description | Default | Type |
---|---|---|---|
iconEmoji (producer) | Use a Slack emoji as an avatar | String | |
iconUrl (producer) | The avatar that the component will use when sending message to a channel or user. | String | |
username (producer) | This is the username that the bot will have when sending messages to a channel or user. | String | |
webhookUrl (producer) | The incoming webhook URL | String | |
synchronous (advanced) | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | false | boolean |
302.3. SlackComponent Copy linkLink copied to clipboard!
The SlackComponent with XML must be configured as a Spring or Blueprint bean that contains the incoming webhook url for the integration as a parameter.
<bean id="slack" class="org.apache.camel.component.slack.SlackComponent"> <property name="webhookUrl" value="https://hooks.slack.com/services/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"/> </bean>
<bean id="slack" class="org.apache.camel.component.slack.SlackComponent">
<property name="webhookUrl" value="https://hooks.slack.com/services/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"/>
</bean>
For Java you can configure this using Java code.
302.4. Example Copy linkLink copied to clipboard!
A CamelContext with Blueprint could be as:
302.5. See Also Copy linkLink copied to clipboard!
- Configuring Camel
- Component
- Endpoint
- Getting Started