slack sink Slack Sink

Provided by: "Apache Software Foundation"

Support Level for this Kamelet is: "Stable"

Send messages to a Slack channel.

Configuration Options

The following table summarizes the configuration options available for the slack-sink Kamelet:

Property Name Description Type Default Example

channel

Channel

Required The Slack channel to send messages to.

string

#myroom

webhookUrl

Webhook URL

Required The webhook URL used by the Slack channel to handle incoming messages.

string

iconEmoji

Icon Emoji

Use a Slack emoji as an avatar.

string

iconUrl

Icon URL

The avatar to use when sending a message to a channel or user.

string

username

Username

The username for the bot when it sends messages to a channel or user.

string

Dependencies

At runtime, the slack-sink Kamelet relies upon the presence of the following dependencies:

  • camel:jackson

  • camel:slack

  • camel:kamelet

Camel JBang usage

Prerequisites

  • You’ve installed JBang.

  • You have executed the following command:

jbang app install camel@apache/camel

Supposing you have a file named route.yaml with this content:

- route:
    from:
      uri: "kamelet:timer-source"
      parameters:
        period: 10000
        message: 'test'
      steps:
        - to:
            uri: "kamelet:log-sink"

You can now run it directly through the following command

camel run route.yaml

Camel K Environment Usage

This section describes how you can use the slack-sink.

Knative sink

You can use the slack-sink Kamelet as a Knative sink by binding it to a Knative object.

slack-sink-binding.yaml
apiVersion: camel.apache.org/v1
kind: KameletBinding
metadata:
  name: slack-sink-binding
spec:
  source:
    ref:
      kind: Channel
      apiVersion: messaging.knative.dev/v1
      name: mychannel
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: slack-sink
    properties:
      channel: "#myroom"
      webhookUrl: The Webhook URL

Prerequisite

You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the slack-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f slack-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind channel:mychannel -p "sink.channel=#myroom" -p "sink.webhookUrl=The Webhook URL" slack-sink

This command creates the KameletBinding in the current namespace on the cluster.

Kafka sink

You can use the slack-sink Kamelet as a Kafka sink by binding it to a Kafka topic.

slack-sink-binding.yaml
apiVersion: camel.apache.org/v1
kind: KameletBinding
metadata:
  name: slack-sink-binding
spec:
  source:
    ref:
      kind: KafkaTopic
      apiVersion: kafka.strimzi.io/v1beta1
      name: my-topic
  sink:
    ref:
      kind: Kamelet
      apiVersion: camel.apache.org/v1
      name: slack-sink
    properties:
      channel: "#myroom"
      webhookUrl: The Webhook URL

Prerequisites

  • You’ve installed Strimzi.

  • You’ve created a topic named my-topic in the current namespace.

  • You have Camel K installed on the cluster.

Procedure for using the cluster CLI

  1. Save the slack-sink-binding.yaml file to your local drive, and then edit it as needed for your configuration.

  2. Run the sink by using the following command:

    kubectl apply -f slack-sink-binding.yaml

Procedure for using the Kamel CLI

Configure and run the sink by using the following command:

kamel bind kafka.strimzi.io/v1beta1:KafkaTopic:my-topic -p "sink.channel=#myroom" -p "sink.webhookUrl=The Webhook URL" slack-sink

This command creates the KameletBinding in the current namespace on the cluster.

Kamelet source file

https://github.com/apache/camel-kamelets/blob/main/kamelets/slack-sink.kamelet.yaml

Back to top