Telegram notification

  • POST
  • /workspaces
  • /:workspace
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /actions

Request

URL PARAMETERS
workspacerequiredstring
The workspace name.
pipeline_idrequiredinteger
The numerical ID of the desired pipeline.
project_namerequiredstring
The name ID of the project.
POST PARAMETERS
namerequiredstring
The name of the action.
typerequiredstring
The type of the action. Should be set to TELEGRAM.
integrationrequiredIntegration
The integration.
contentstring
The content of the notification.
file_attachmentsstring[]
The attached files.

Last modified on Jan 19, 2026

Request example

curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \ -H "Authorization: Bearer <YOUR-TOKEN>" \ -H "Content-Type: application/json" \ -d '{ "name": "Telegram notification", "type": "TELEGRAM", "trigger_time": "ON_EVERY_EXECUTION", "content": "[#$BUDDY_RUN_ID] $BUDDY_PIPELINE_NAME execution by [$BUDDY_INVOKER_NAME]($BUDDY_INVOKER_URL)", "file_attachments": [ "fs:///file1", "fs:///file2" ], "integration": { "id": 1 } }'

Response

EXAMPLE RESPONSE
{ "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions/1", "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1/action/1/edit", "id": 1, "name": "Telegram notification", "type": "TELEGRAM", "trigger_time": "ON_EVERY_EXECUTION", "last_execution_status": "INITIAL", "content": "[#$BUDDY_RUN_ID] $BUDDY_PIPELINE_NAME execution by [$BUDDY_INVOKER_NAME]($BUDDY_INVOKER_URL)", "file_attachments": [ "fs:///file1", "fs:///file2" ], "integration": { "id": 1 }, "pipeline": { "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1", "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/1", "id": 1, "name": "test server", "on": "CLICK", "refs": [ "refs/heads/master" ], "last_execution_status": "SUCCESSFUL", "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08" } }
STATUS
201 Created