Download Recording Media with Twilio API on New Webhook Event (Instant) from Heroku API

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

Trigger workflow on

New Webhook Event (Instant) from the Heroku API

Next, do this

Download Recording Media with the Twilio 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 Heroku trigger and Twilio action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Webhook Event (Instant) trigger
1. Connect your Heroku account
2. Select a App ID
3. Select one or more Entities
Configure the Download Recording Media action
1. Connect your Twilio account
2. Select a Recording ID
3. Select a Format
4. Configure File Path
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 Webhook Event (Instant) on Heroku

Description:Emit new event on each webhook event. [See the documentation](https://devcenter.heroku.com/articles/app-webhooks-schema#webhook-create)

Version:0.0.1

Key:heroku-new-webhook-event-instant

View on GitHub

Heroku Overview#

The Heroku API offers programmatic access to Heroku's cloud platform, enabling developers to automate, extend, and integrate their app's lifecycle events with other services. With Pipedream, you can harness the Heroku API for powerful automation, such as managing apps, dynos, add-ons, and configuring scaling operations. Pipedream's ability to connect with multiple services allows for creating complex workflows, such as syncing your development pipeline with external project management tools or triggering alerts based on app metrics.

Trigger Code#

import heroku from "../../heroku.app.mjs";
import sampleEmit from "./test-event.mjs";

export default {
  key: "heroku-new-webhook-event-instant",
  name: "New Webhook Event (Instant)",
  description: "Emit new event on each webhook event. [See the documentation](https://devcenter.heroku.com/articles/app-webhooks-schema#webhook-create)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    heroku,
    http: "$.interface.http",
    db: "$.service.db",
    appId: {
      propDefinition: [
        heroku,
        "appId",
      ],
    },
    entities: {
      propDefinition: [
        heroku,
        "entities",
      ],
    },
  },
  hooks: {
    async activate() {
      const { id } = await this.heroku.createWebhookSubscription({
        appId: this.appId,
        data: {
          include: this.entities,
          level: "notify",
          url: this.http.endpoint,
        },
      });
      this._setHookId(id);
    },
    async deactivate() {
      const hookId = this._getHookId();
      if (hookId) {
        await this.heroku.deleteWebhookSubscription({
          appId: this.appId,
          hookId,
        });
      }
    },
  },
  methods: {
    _getHookId() {
      return this.db.get("hookId");
    },
    _setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
    generateMeta(event) {
      return {
        id: event.id,
        summary: `New ${event.webhook_metadata.event.include} - ${event.action} Event`,
        ts: Date.now(),
      };
    },
  },
  async run(event) {
    const { body } = event;
    if (!body) {
      return;
    }
    const meta = this.generateMeta(body);
    this.$emit(body, meta);
  },
  sampleEmit,
};

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
Heroku	`heroku`	`app`	This component uses the Heroku app.
N/A	`http`	`$.interface.http`	This 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/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
App ID	`appId`	`string`	Select a value from the drop down menu.
Entities	`entities`	`string[]`	Select a value from the drop down menu:`{ "value": "api:addon-attachment", "label": "addon-attachment - An add-on has been attached or removed from the app" }{ "value": "api:addon", "label": "addon - An add-on for the app has been newly provisioned or deleted, or its details have been modified" }{ "value": "api:app", "label": "app - The app itself has been provisioned or deleted, or its details have been modified" }{ "value": "api:build", "label": "build - A new build for the app has been initiated or the build’s status has changed since the last notification" }{ "value": "api:collaborator", "label": "collaborator - A collaborator has been added or removed from the app, or an existing collaborator’s details have been modified" }{ "value": "api:domain", "label": "domain - Custom domain details have been added or removed from the app" }{ "value": "api:dyno", "label": "dyno - A new dyno has begun running for the app" }{ "value": "api:formation", "label": "formation - The dyno formation for a particular process type has been modified" }{ "value": "api:release", "label": "release - A new release for the app has been initiated or the release’s status has changed since the last notification" }{ "value": "api:sni-endpoint", "label": "sni-endpoint - An SNI endpoint has been specified or removed for the app, or the existing SNI endpoint’s details have been modified" }`

Trigger Authentication#

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

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

global

About Heroku#

Cloud infrastructure

Action#

Download Recording Media on Twilio

Description:Download a recording media file. [See the documentation](https://www.twilio.com/docs/voice/api/recording#fetch-a-recording-media-file)

Version:0.1.6

Key:twilio-download-recording-media

View on GitHub

Twilio Overview#

Twilio's API on Pipedream opens up a multitude of communication capabilities, allowing you to build robust, scalable, and automated workflows. With Twilio, you can send and receive SMS and MMS messages, make voice calls, and perform other communication functions programmatically. Leveraging Pipedream's seamless integration, you can connect these communications features with hundreds of other services to automate notifications, streamline customer interactions, and enhance operational efficiency.

Action Code#

import twilio from "../../twilio.app.mjs";
import stream from "stream";
import { promisify } from "util";
import fs from "fs";
import { axios } from "@pipedream/platform";

export default {
  key: "twilio-download-recording-media",
  name: "Download Recording Media",
  description: "Download a recording media file. [See the documentation](https://www.twilio.com/docs/voice/api/recording#fetch-a-recording-media-file)",
  version: "0.1.6",
  type: "action",
  props: {
    twilio,
    recordingID: {
      propDefinition: [
        twilio,
        "recordingID",
      ],
    },
    format: {
      propDefinition: [
        twilio,
        "format",
      ],
    },
    filePath: {
      type: "string",
      label: "File Path",
      description: "The destination path in [`/tmp`](https://pipedream.com/docs/workflows/steps/code/nodejs/working-with-files/#the-tmp-directory) for the downloaded the file (e.g., `/tmp/myFile.mp3`). Make sure to include the file extension.",
    },
  },
  methods: {
    getFileStream({
      $, downloadUrl,
    }) {
      return axios($, {
        url: downloadUrl,
        auth: {
          username: `${this.twilio.$auth.AccountSid}`,
          password: `${this.twilio.$auth.AuthToken}`,
        },
        responseType: "stream",
      });
    },
  },
  async run({ $ }) {
    // Get Recording resource to get `uri`
    const recording = await this.twilio.getRecording(this.recordingID);
    const client = this.twilio.getClient();
    // `uri` ends in ".json" - remove ".json" from uri
    const uri = client.api.absoluteUrl(recording.uri).replace(".json", "");
    // Add chosen download format extension (e.g. ".mp3"), as specified in the Twilio API docs:
    // https://www.twilio.com/docs/voice/api/recording#fetch-a-recording-media-file
    const downloadUrl = uri + this.format;
    const fileStream = await this.getFileStream({
      $,
      downloadUrl,
    });
    const pipeline = promisify(stream.pipeline);
    const resp = await pipeline(
      fileStream,
      fs.createWriteStream(this.filePath.includes("/tmp")
        ? this.filePath
        : `/tmp/${this.filePath}`),
    );
    $.export("$summary", `Successfully downloaded the recording media file to "${this.filePath}"`);
    return resp;
  },
};

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
Twilio	`twilio`	`app`	This component uses the Twilio app.
Recording ID	`recordingID`	`string`	Select a value from the drop down menu.
Format	`format`	`string`	Select a value from the drop down menu:`{ "label": "MP3", "value": ".mp3" }{ "label": "WAV", "value": ".wav" }`
File Path	`filePath`	`string`	The destination path in `/tmp` for the downloaded the file (e.g., `/tmp/myFile.mp3`). Make sure to include the file extension.

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.

To connect your Twilio account to Pipedream,

API Key and API Key SID

First, create an API key in Twilio.

There are three types of keys: Main, Standard, and Restricted. You'll need a Main key to interact with certain API endpoints, like /Accounts.
If you don't need to interact with those endpoints, you can use a Standard or Restricted key.

After creating your key, you'll see fields for Sid and Secret. Enter those in the fields below.

Account SID and Auth Token

Visit your Twilio Dashboard. You'll see your Account SID and Auth Token under Account info.

About Twilio#

Twilio is a cloud communications platform for building SMS, Voice & Messaging applications on an API built for global scale.

More Ways to Connect Twilio + Heroku#

Other Popular Integrations#

Check Verification Token with Twilio API on New Webhook Event (Instant) from Heroku API

Heroku + Twilio