← GitHub + Twilio integrations

Send SMS with Twilio APIon New or Updated Pull Request (Instant) from GitHub API

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

Trigger workflow on
New or Updated Pull Request (Instant) from the GitHub API
Next, do this
Send SMS with the Twilio API
No credit card required
Trusted by 200,000+ developers from startups to Fortune 500 companies:
Trusted by 200,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

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

  1. Select this integration
  2. Configure the New or Updated Pull Request (Instant) trigger
    1. Connect your GitHub account
    2. Select a Repo
  3. Configure the Send SMS action
    1. Connect your Twilio account
    2. Select a From
    3. Configure To
    4. Configure Message Body
  4. Deploy the workflow
  5. Send a test event to validate your setup
  6. Turn on the trigger

Details

This integration uses pre-built, open source 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

Description:Emit new events when a pull request is opened or updated
Version:0.0.4
Key:github-new-or-updated-pull-request

Trigger Code

import common from "../common-webhook.js";

export default {
  ...common,
  key: "github-new-or-updated-pull-request",
  name: "New or Updated Pull Request (Instant)",
  description: "Emit new events when a pull request is opened or updated",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  methods: {
    ...common.methods,
    getEventNames() {
      return [
        "pull_request",
      ];
    },
    getEventTypes() {
      return [
        "opened",
        "edited",
        "closed",
        "assigned",
        "unassigned",
        "review_requested",
        "review_request_removed",
        "ready_for_review",
        "converted_to_draft",
        "labeled",
        "unlabeled",
        "synchronize",
        "auto_merge_enabled",
        "auto_merge_disabled",
        "locked",
        "unlocked",
        "reopened",
      ];
    },
    generateMeta(data, id) {
      const ts = data.pull_request.updated_at
        ? Date.parse(data.pull_request.updated_at)
        : Date.parse(data.pull_request.created_at);
      return {
        id,
        summary: `${data.pull_request.title} ${data.action} by ${data.sender.login}`,
        ts,
      };
    },
  },
};

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.
LabelPropTypeDescription
GitHubgithubappThis component uses the GitHub app.
ReporepoFullNamestringSelect a value from the drop down menu.
N/Ahttp$.interface.httpThis component uses $.interface.http to generate a unique URL when the component is first instantiated. Each request to the URL will trigger the run() method of the component.
N/Adb$.service.dbThis component uses $.service.db to maintain state between component invocations.

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_hookgistnotificationsuserwrite:discussionwrite:packagesread:packages

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

Description:Send a simple text-only SMS.
Version:0.0.4
Key:twilio-send-sms

Action Code

// Read the Twilio docs at https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource
const twilio = require("../../twilio.app.js");
const { phone } = require("phone");

module.exports = {
  key: "twilio-send-sms",
  name: "Send SMS",
  description: "Send a simple text-only SMS.",
  type: "action",
  version: "0.0.4",
  props: {
    twilio,
    from: {
      propDefinition: [
        twilio,
        "from",
      ],
    },
    to: {
      propDefinition: [
        twilio,
        "to",
      ],
    },
    body: {
      propDefinition: [
        twilio,
        "body",
      ],
    },
  },
  async run() {
    // Parse the given number into its E.164 equivalent
    // The E.164 phone number will be included in the first element
    // of the array, but the array will be empty if parsing fails.
    // See https://www.npmjs.com/package/phone
    const toParsed = phone(this.to);
    if (!toParsed || !toParsed.phoneNumber) {
      throw new Error(`Phone number ${this.to} couldn't be parsed as a valid number.`);
    }

    const data = {
      to: toParsed.phoneNumber,
      from: this.from,
      body: this.body,
    };

    return await this.twilio.getClient().messages.create(data);
  },
};

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.

LabelPropTypeDescription
TwiliotwilioappThis component uses the Twilio app.
FromfromstringSelect a value from the drop down menu.
Totostring

The destination phone number in E.164 format. Format with a + and country code (e.g., +16175551212).

Message Bodybodystring

The text of the message you want to send, limited to 1600 characters.

Action Authentication

Twilio uses API keys for authentication. When you connect your Twilio account, Pipedream securely stores the keys so you can easily authenticate to Twilio APIs in both code and no-code steps.

In Twilio, create an API key. There are two types of keys: Master and Standard. You'll need a Master key to interact with certain API endpoints, like /Accounts. If you don't need to interact with those endpoints, you can use a Standard key.

Once created, you'll receive an Sid and Secret here that you should enter in the corresponding fields below.

Then, in your Twilio Dashboard, you'll see your Account SID listed near the top. This is required for certain API operations. Enter that in the AccountSid field below.

About Twilio

Cloud communications platform for building SMS, Voice & Messaging applications on an API built for global scale

More Ways to Connect Twilio + GitHub

About Pipedream

Stop writing boilerplate code, struggling with authentication and managing infrastructure. Start connecting APIs with code-level control when you need it — and no code when you don't.

Into to Pipedream
Watch us build a workflow
Watch us build a workflow
4 min
Watch now ➜
"The past few weeks, I truly feel like the clichéd 10x engineer."
@heyellieday
Powerful features that scale
Manage concurrency and execution rate
Manage concurrency and execution rate

Queue up to 10,000 events per workfow and manage the concurrency and rate at which workflows are triggered.

Process large payloads up to 5 terabytes
Process large payloads up to 5 terabytes

Large file support enables you to trigger workflows with any data (e.g., large JSON files, images and videos) up to 5 terabytes.

Return custom responses to HTTP requests
Return custom responses to HTTP requests

Return any JSON-serializable response from an HTTP triggered workflow using $respond().

Use most npm packages
Use most npm packages

To use any npm package, just require() it -- there's no npm install or package.json required.

Maintain state between executions
Maintain state between executions

Use $checkpoint to save state in one workflow invocation and read it the next time your workflow runs.

Pass data between steps
Pass data between steps

Return data from any step to inspect it in a human-friendly way and reference the data in future steps via the steps object.