This is an automated email from the ASF dual-hosted git repository.
bossenti pushed a commit to branch dev
in repository https://gitbox.apache.org/repos/asf/streampipes-website.git
The following commit(s) were added to refs/heads/dev by this push:
new b31fcba3e chore(extensions-docs): update extensions doc assets to
recent development state (#145)
b31fcba3e is described below
commit b31fcba3e2ca940836153caf350519c5fe59ac40
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Mon Dec 4 07:55:20 2023 +0100
chore(extensions-docs): update extensions doc assets to recent development
state (#145)
Co-authored-by: dominikriemer <[email protected]>
---
....streampipes.sinks.notifications.jvm.msteams.md | 80 +++++++++++++++++++++
website-v2/sidebars.json | 3 +-
.../icon.png | Bin 0 -> 126479 bytes
3 files changed, 82 insertions(+), 1 deletion(-)
diff --git a/docs/pe/org.apache.streampipes.sinks.notifications.jvm.msteams.md
b/docs/pe/org.apache.streampipes.sinks.notifications.jvm.msteams.md
new file mode 100644
index 000000000..8b819b816
--- /dev/null
+++ b/docs/pe/org.apache.streampipes.sinks.notifications.jvm.msteams.md
@@ -0,0 +1,80 @@
+---
+id: org.apache.streampipes.sinks.notifications.jvm.msteams
+title: MS Teams Sink
+sidebar_label: MS Teams Sink
+---
+
+<!--
+ ~ Licensed to the Apache Software Foundation (ASF) under one or more
+ ~ contributor license agreements. See the NOTICE file distributed with
+ ~ this work for additional information regarding copyright ownership.
+ ~ The ASF licenses this file to You under the Apache License, Version 2.0
+ ~ (the "License"); you may not use this file except in compliance with
+ ~ the License. You may obtain a copy of the License at
+ ~
+ ~ http://www.apache.org/licenses/LICENSE-2.0
+ ~
+ ~ Unless required by applicable law or agreed to in writing, software
+ ~ distributed under the License is distributed on an "AS IS" BASIS,
+ ~ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ ~ See the License for the specific language governing permissions and
+ ~ limitations under the License.
+ ~
+ -->
+
+# MS Teams Sink
+
+<p align="center">
+ <img
src="/img/pipeline-elements/org.apache.streampipes.sinks.notifications.jvm.msteams/icon.png"
width="150px;" class="pe-image-documentation"/>
+</p>
+
+---
+
+
+
+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
