Microsoft Teams

POST
/workspaces
/:domain
/projects
/:project_name
/pipelines
/:pipeline_id
/actions

Hint

List with common parameters for all Buddy actions

Request

URL PARAMETERS

domainrequired string

The workspace domain.

pipeline_idrequired integer

The numerical ID of the desired pipeline.

project_namerequired string

The name ID of the project.

POST PARAMETERS

namerequired string

The name of the action.

typerequired string

The type of the action. Should be set to MICROSOFT_TEAMS.

titlerequired string

The title of the notification.

contentrequired string

The content of the notification.

recipientsrequired string

The recipient of the notification: email address.

file_attachmentsstring[]

The attached files.

send_as_htmlboolean

Defines whether to send the content as HTML.

Last modified on Oct 29, 2024

MacOS Netlify

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "name": "Send Microsoft Teams notification",
  "type": "MICROSOFT_TEAMS",
  "trigger_time": "ON_EVERY_EXECUTION",
  "content": "[#$BUDDY_RUN_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"
  ]
}'

EXAMPLE RESPONSE
{
  "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 Microsoft Teams notification",
  "type": "MICROSOFT_TEAMS",
  "trigger_time": "ON_EVERY_EXECUTION",
  "content": "[#$BUDDY_RUN_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"
  }
}

STATUS
201 Created

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999