Emergency Push Notification with Pushover API on New Branch Created from GitHub API

Pipedream makes it easy to connect APIs for Pushover, GitHub and 2,400+ other apps remarkably fast.

Trigger workflow on

New Branch Created from the GitHub API

Next, do this

Emergency Push Notification with the Pushover API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a GitHub trigger and Pushover action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Branch Created trigger
1. Connect your GitHub account
2. Select a Repository
Configure the Emergency Push Notification action
1. Connect your Pushover account
2. Configure Message
3. Configure Retry
4. Configure Expire
5. Optional- Configure Callback
6. Optional- Configure Title
7. Optional- Configure URL
8. Optional- Configure URL Title
9. Optional- Configure Device
10. Optional- Select a Sound
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Details#

This integration uses pre-built, source-available components from Pipedream's GitHub repo. These components are developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

Trigger#

New Branch Created on GitHub

Description:Emit new event when a branch is created.

Version:1.0.7

Key:github-new-branch

View on GitHub

GitHub Overview#

The GitHub API is a powerful gateway to interaction with GitHub's vast web of data and services, offering a suite of endpoints to manipulate and retrieve information on repositories, pull requests, issues, and more. Harnessing this API on Pipedream, you can orchestrate automated workflows that respond to events in real-time, manage repository data, streamline collaborative processes, and connect GitHub with other services for a more integrated development lifecycle.

Trigger Code#

import common from "../common/common-flex.mjs";
import {
  getSampleTimerEvent, getSampleWebhookEvent,
} from "./common-sample-events.mjs";

export default {
  ...common,
  key: "github-new-branch",
  name: "New Branch Created",
  description: "Emit new event when a branch is created.",
  version: "1.0.7",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getSampleTimerEvent,
    getSampleWebhookEvent,
    getWebhookEvents() {
      return [
        "create",
      ];
    },
    shouldEmitWebhookEvent(body) {
      return body?.ref_type === "branch";
    },
    getId(item) {
      return item.ref ?? item.name;
    },
    getSummary(item) {
      return `New branch: ${this.getId(item)}`;
    },
    getPollingData(args) {
      return this.github.getBranches(args);
    },
    getHttpDocsLink() {
      return "https://docs.github.com/en/webhooks/webhook-events-and-payloads#create";
    },
    getTimerDocsLink() {
      return "https://docs.github.com/en/rest/branches/branches?apiVersion=2022-11-28#list-branches";
    },
  },
};

Trigger Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
GitHub	`github`	`app`	This component uses the GitHub app.
Repository	`repoFullname`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

GitHub uses OAuth authentication. When you connect your GitHub account, Pipedream will open a popup window where you can sign into GitHub and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any GitHub API.

Pipedream requests the following authorization scopes when you connect your account:

repoadmin:orgadmin:public_keyadmin:org_hookgistprojectnotificationsuserwrite:discussionwrite:packagesread:packagesadmin:repo_hook

About GitHub#

Where the world builds software. Millions of developers and companies build, ship, and maintain their software on GitHub—the largest and most advanced development platform in the world.

Action#

Emergency Push Notification on Pushover

Description:Sends an Emergency Push Notification to devices with Pushover. Notifications are repeated until they are acknowledged by the user. More information at [Pushing Messages](https://pushover.net/api#messages) and [Message Priority](https://pushover.net/api#priority)

Version:0.0.4

Key:pushover-emergency-push-notification

View on GitHub

Pushover Overview#

Pushover makes it easy to send real-time notifications to your Android and iOS devices. By leveraging the Pushover API on Pipedream, you can craft customized messages triggered by various events and send them to users instantly. This integration can be especially useful for monitoring systems, to-do list reminders, or even to keep tabs on your online services and workflows.

Action Code#

import pushover from "../../pushover.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "pushover-emergency-push-notification",
  name: "Emergency Push Notification",
  description: `Sends an Emergency Push Notification to devices with Pushover.
    Notifications are repeated until they are acknowledged by the user.
    More information at [Pushing Messages](https://pushover.net/api#messages) and [Message Priority](https://pushover.net/api#priority)`,
  version: "0.0.4",
  type: "action",
  props: {
    pushover,
    message: {
      propDefinition: [
        pushover,
        "message",
      ],
    },
    retry: {
      propDefinition: [
        pushover,
        "retry",
      ],
    },
    expire: {
      propDefinition: [
        pushover,
        "expire",
      ],
    },
    callback: {
      type: "string",
      label: "Callback",
      description: "A publicly-accessible URL that Pushover will send a request to when the user has acknowledged the notification",
      optional: true,
    },
    title: {
      propDefinition: [
        pushover,
        "title",
      ],
    },
    url: {
      propDefinition: [
        pushover,
        "url",
      ],
    },
    urlTitle: {
      propDefinition: [
        pushover,
        "urlTitle",
      ],
    },
    device: {
      propDefinition: [
        pushover,
        "device",
      ],
    },
    sound: {
      propDefinition: [
        pushover,
        "sound",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    const {
      message,
      title,
      url,
      urlTitle,
      device,
      retry,
      expire,
      sound,
      callback,
    } = this;
    const response = await this.pushover.pushMessage({
      $,
      params: {
        message,
        title,
        url,
        device,
        priority: constants.PRIORITY.EMERGENCY,
        retry,
        expire,
        sound,
        callback,
        url_title: urlTitle,
      },
    });
    $.export("$summary", `Successfully sent emergency notification with message: "${message}"`);

    return response;
  },
};

Action Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI.

Label	Prop	Type	Description
Pushover	`pushover`	`app`	This component uses the Pushover app.
Message	`message`	`string`	The notification message
Retry	`retry`	`integer`	How often, in seconds, Pushover will send the same notification. In a situation where your user might be in a noisy environment or sleeping, retrying the notification (with sound and vibration) will help get his or her attention. This parameter must have a value of at least 30 seconds between retries.
Expire	`expire`	`integer`	Notification expiration time, in seconds. If the notification has not been acknowledged in expire seconds, it will be marked as expired and will stop being sent to the user. Note that the notification is still shown to the user after it is expired, but it will not prompt the user for acknowledgement. This parameter must have a maximum value of at most 10800 seconds (3 hours).
Callback	`callback`	`string`	A publicly-accessible URL that Pushover will send a request to when the user has acknowledged the notification
Title	`title`	`string`	The message title
URL	`url`	`string`	A supplementary URL to show with the message
URL Title	`urlTitle`	`string`	A title for the supplementary URL. If blank, the URL is shown
Device	`device`	`string`	The device name to send the message directly. Can be comma-separated names for sending to multiple devices
Sound	`sound`	`string`	Select a value from the drop down menu.

Emergency Push Notification with Pushover API on New Branch Created from GitHub API

Pipedream makes it easy to connect APIs for Pushover, GitHub and 2,400+ other apps remarkably fast.

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular