Pushover

Learn more about:

POST Parameters

List with common parameters for all Buddy actions

Name	Type	Description
name `Required`	String	The name of the action.
type `Required`	String	The type of the action. Should be set to `PUSHOVER`.
integration `Required`	String	The integration.
content `Required`	String	The content of the notification.
device	String	The name of the device to whick notification will be sent.
priority	String	Specifies the priority of the notification. Can be one of `LOW`, `NORMAL` or `HIGH`.
link	String	The link of the notification.
link_title	String	The title of the notification link.
title	String	The title of the notification.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions

JSON

{
  "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"
  }
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "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"
  }
}

Last modified on November 16, 2022