Pushover

  • POST
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /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 PUSHOVER.
integrationrequired string
The integration.
contentrequired string
The content of the notification.
deviceoptional string
The name of the device to which the notification will be sent.
priorityoptional string
Specifies the priority of the notification. Can be one of LOW, NORMAL or HIGH.
linkoptional string
The link of the notification.
link_titleoptional string
The title of the notification link.
titleoptional string
The title of the notification.

Last modified on Oct 7, 2024

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 notification to My-Chrome",
  "type": "PUSHOVER",
  "title": "$title",
  "trigger_time": "ON_EVERY_EXECUTION",
  "variables": [
    {
      "key": "title",
      "value": "Notification title"
    }
  ],
  "content": "${BUDDY_PIPELINE_NAME} execution #${BUDDY_EXECUTION_ID}",
  "link": "${BUDDY_EXECUTION_URL}",
  "link_title": "Show execution details",
  "device": "My-Chrome",
  "priority": "HIGH",
  "integration": {
    "hash_id": "5ddb7c180fb38be67bd78a88a"
  }
}'
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": "Send notification to My-Chrome", "type": "PUSHOVER", "title": "$title", "trigger_time": "ON_EVERY_EXECUTION", "variables": [ { "key": "title", "value": "Notification title" } ], "content": "${BUDDY_PIPELINE_NAME} execution #${BUDDY_EXECUTION_ID}", "link": "${BUDDY_EXECUTION_URL}", "link_title": "Show execution details", "device": "My-Chrome", "priority": "HIGH", "integration": { "url": "https://api.buddy.works/workspaces/buddy/user/integrations/1", "html_url": "https://app.buddy.works/integrations", "hash_id": "5ddb7c180fb38be67bd78a88a" }, "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
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999