diff --git a/docs-python/dev/scripts/gen_ref_pages/index.html b/docs-python/dev/scripts/gen_ref_pages/index.html index b668bdfff..d8defd221 100644 --- a/docs-python/dev/scripts/gen_ref_pages/index.html +++ b/docs-python/dev/scripts/gen_ref_pages/index.html @@ -3168,7 +3168,7 @@
+ +
+ +--- + + + +The MS Teams Sink is a StreamPipes data sink that facilitates the sending of messages to a Microsoft Teams channel +through a Webhook URL. Whether you need to convey simple text messages or employ more advanced formatting with [Adaptive +Cards](https://adaptivecards.io/), this sink provides a versatile solution for integrating StreamPipes with Microsoft Teams. + +--- + +## Required input + +The MS Teams Sink does not have any specific requirements for incoming event types. It is designed to work seamlessly +with any type of incoming event, making it a versatile choice for various use cases. + +--- + +## Configuration + +#### Webhook URL + +To configure the MS Teams Sink, you need to provide the Webhook URL that enables the sink to send messages to a specific +MS Teams channel. If you don't have a Webhook URL, you can learn how to create +one [here](https://learn.microsoft.com/en-us/microsoftteams/platform/webhooks-and-connectors/how-to/add-incoming-webhook?tabs=dotnet#create-incoming-webhooks-1). + +#### Message Content Options + +You can choose between two message content formats: + +- **Simple Message Content:** Supports plain text and basic markdown formatting. +- **Advanced Message Content:** Expects JSON input directly forwarded to Teams without modification. This format is + highly customizable and can be used for Adaptive Cards. + +Choose the format that best suits your messaging needs. + +--- + +## Usage + +#### Simple Message Format + +In the simple message format, you can send plain text messages or utilize basic markdown formatting to convey +information. This is ideal for straightforward communication needs. + +#### Advanced Message Format + +For more sophisticated messaging requirements, the advanced message format allows you to send JSON content directly to +Microsoft Teams without modification. This feature is especially powerful when used +with [Adaptive Cards](https://learn.microsoft.com/en-us/adaptive-cards/), enabling interactive and dynamic content in +your Teams messages. diff --git a/website-v2/sidebars.json b/website-v2/sidebars.json index 99f110b46..1c76db02c 100644 --- a/website-v2/sidebars.json +++ b/website-v2/sidebars.json @@ -159,6 +159,7 @@ "pe/org.apache.streampipes.sinks.brokers.jvm.jms", "pe/org.apache.streampipes.sinks.brokers.jvm.kafka", "pe/org.apache.streampipes.sinks.brokers.jvm.mqtt", + "pe/org.apache.streampipes.sinks.notifications.jvm.msteams", "pe/org.apache.streampipes.sinks.brokers.jvm.nats", "pe/org.apache.streampipes.sinks.internal.jvm.notification", "pe/org.apache.streampipes.sinks.databases.jvm.opcua", @@ -216,4 +217,4 @@ "faq-common-problems" ] } -} +} \ No newline at end of file diff --git a/website-v2/static/img/pipeline-elements/org.apache.streampipes.sinks.notifications.jvm.msteams/icon.png b/website-v2/static/img/pipeline-elements/org.apache.streampipes.sinks.notifications.jvm.msteams/icon.png new file mode 100644 index 000000000..c8479db69 Binary files /dev/null and b/website-v2/static/img/pipeline-elements/org.apache.streampipes.sinks.notifications.jvm.msteams/icon.png differ