TeamsExecution

type: "io.kestra.plugin.notifications.teams.TeamsExecution"

Send a Microsoft Teams message with the execution information

The message will include a link to the execution page in the UI along with the execution ID, namespace, flow name, the start date, duration and the final status of the execution, and (if failed) the task that led to a failure.

Use this notification task only in a flow that has a Flow trigger. Don't use this notification task in errors tasks. Instead, for errors tasks, use the TeamsIncomingWebhook task.

Examples

Send a Microsoft Teams notification on a failed flow execution

id: failure_alert
namespace: company.team

tasks:
  - id: send_alert
    type: io.kestra.plugin.notifications.teams.TeamsExecution
    url: "{{ secret('TEAMS_WEBHOOK') }}" # format: https://microsoft.webhook.office.com/webhook/xyz
    activityTitle: "Kestra Teams notification"
    executionId: "{{ trigger.executionId }}"

triggers:
  - id: failed_prod_workflows
    type: io.kestra.plugin.core.trigger.Flow
    conditions:
      - type: io.kestra.plugin.core.condition.ExecutionStatusCondition
        in:
          - FAILED
          - WARNING
      - type: io.kestra.plugin.core.condition.ExecutionNamespaceCondition
        namespace: prod
        prefix: true

Properties

url

• Type: string
• Dynamic: ✔️
• Required: ✔️
• Min length: 1

Microsoft Teams incoming webhook URL

activitySubtitle

• Type: string
• Dynamic: ✔️
• Required: ❌

Activity Subtitle

activityTitle

• Type: string
• Dynamic: ✔️
• Required: ❌

Activity Title

customFields

• Type: object
• Dynamic: ✔️
• Required: ❌

Custom fields to be added on notification

customMessage

• Type: string
• Dynamic: ✔️
• Required: ❌

Custom message to be added on notification

executionId

• Type: string
• Dynamic: ✔️
• Required: ❌
• Default: {{ execution.id }}

The execution id to use

Default is the current execution, change it to {{ trigger.executionId }} if you use this task with a Flow trigger to use the original execution.

options

• Type: AbstractHttpOptionsTask-RequestOptions
• Dynamic: ✔️
• Required: ❌

Options

The options to set to customize the HTTP client

payload

• Type: string
• Dynamic: ✔️
• Required: ❌

Microsoft Teams message payload

templateRenderMap

• Type: object
• Dynamic: ✔️
• Required: ❌

Map of variables to use for the message template

themeColor

• Type: string
• Dynamic: ✔️
• Required: ❌
• Default: 0076D7

Theme color

Definitions

java.nio.charset.Charset

Properties

io.kestra.plugin.notifications.AbstractHttpOptionsTask-RequestOptions

Properties

connectTimeout

• Type:
  • string
  • string
• Dynamic: ✔️
• Required: ❌

connectionPoolIdleTimeout

• Type:
  • string
  • string
• Dynamic: ✔️
• Required: ❌

defaultCharset

• Type:
  • Charset
  • string
• Dynamic: ✔️
• Required: ❌

maxContentLength

• Type:
  • integer
  • string
• Dynamic: ✔️
• Required: ❌

readIdleTimeout

• Type:
  • string
  • string
• Dynamic: ✔️
• Required: ❌

readTimeout

• Type:
  • string
  • string
• Dynamic: ✔️
• Required: ❌