Microsoft Teams
POST Parameters
| Name | Type | Description |
|---|---|---|
name Required | String | The name of the action. |
type Required | String | The type of the action. Should be set to MICROSOFT_TEAMS. |
title Required | String | The title of the notification. |
content Required | String | The content of the notification. |
recipients Required | String | The recipient of the notification: email address. |
| file_attachments | String[] | The attached files. |
| send_as_html | Boolean | Defines whether to send the content as HTML. |
Example
Request
POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actionsJSON
{
"name": "Send Mcirosoft Teams notification",
"type": "MICROSOFT_TEAMS",
"trigger_time": "ON_EVERY_EXECUTION",
"content": "[#$BUDDY_EXECUTION_ID] $BUDDY_PIPELINE_NAME execution by [$BUDDY_INVOKER_NAME]($BUDDY_INVOKER_URL)",
"recipients": "example@example.com",
"title": "$title",
"send_as_html": true,
"file_attachments": [
"attachment"
]
}Sample Response
HTTP
Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999JSON
{
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit",
"id": 2,
"name": "Send Mcirosoft Teams notification",
"type": "MICROSOFT_TEAMS",
"trigger_time": "ON_EVERY_EXECUTION",
"content": "[#$BUDDY_EXECUTION_ID] $BUDDY_PIPELINE_NAME execution by [$BUDDY_INVOKER_NAME]($BUDDY_INVOKER_URL)",
"recipients": "example@example.com",
"title": "$title",
"send_as_html": true,
"file_attachments": [
"attachment"
],
"pipeline": {
"url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2",
"html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2",
"id": 2,
"name": "test server",
"on": "CLICK",
"refs": [
"refs/heads/master"
],
"last_execution_status": "SUCCESSFUL",
"last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08"
}
}Last modified on November 16, 2022