Send Fax with Telnyx API on New Requests from HTTP / Webhook API

Pipedream makes it easy to connect APIs for Telnyx, HTTP / Webhook and 2,400+ other apps remarkably fast.

Trigger workflow on

New Requests from the HTTP / Webhook API

Next, do this

Send Fax with the Telnyx 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 HTTP / Webhook trigger and Telnyx action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Requests trigger
1. Optional- Configure Body Only
2. Optional- Configure Response Status Code
3. Optional- Configure Response Content-Type
4. Optional- Configure Response Body
5. Connect your HTTP / Webhook account
Configure the Send Fax action
1. Connect your Telnyx account
2. Select a Fax Application ID
3. Configure Media URL
4. Select a Phone Number
5. Configure To
6. Optional- Configure From Display Name
7. Optional- Select a Quality
8. Optional- Configure TS38 Enabled
9. Optional- Configure Monochrome
10. Optional- Configure Store Media
11. Optional- Configure Webhook URL
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 Requests on HTTP / Webhook

Description:Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.

Version:0.1.1

Key:http-new-requests

View on GitHub

HTTP / Webhook Overview#

Build, test, and send HTTP requests without code using your Pipedream workflows. The HTTP / Webhook action is a tool to build HTTP requests with a Postman-like graphical interface.

Point and click HTTP requests

Define the target URL, HTTP verb, headers, query parameters, and payload body without writing custom code.

$A screenshot of Pipedream's HTTP Request Configuration interface with a GET request type selected. The request URL is set to 'https://api.openai.com/v1/models'. The 'Auth' tab is highlighted, indicating that authentication is required for this request. In the headers section, there are two headers configured: 'User-Agent' is set to 'pipedream/1', and 'Authorization' is set to 'Bearer {{openai_api_key}}', showing how the OpenAI account's API key is dynamically inserted into the headers to handle authentication automatically.$

Here's an example workflow that uses the HTTP / Webhook action to send an authenticated API request to OpenAI.

Focus on integrating, not authenticating

This action can also use your connected accounts with third-party APIs. Selecting an integrated app will automatically update the request’s headers to authenticate with the app properly, and even inject your token dynamically.

Pipedream integrates with thousands of APIs, but if you can’t find a Pipedream integration simply use Environment Variables in your request headers to authenticate with.

Compatible with no code actions or Node.js and Python

The HTTP/Webhook action exports HTTP response data for use in subsequent workflow steps, enabling easy data transformation, further API calls, database storage, and more.

Response data is available for both coded (Node.js, Python) and no-code steps within your workflow.

Trigger Code#

import http from "../../http.app.mjs";

// Core HTTP component
export default {
  key: "http-new-requests",
  name: "New Requests",
  description: "Get a URL and emit the full HTTP event on every request (including headers and query parameters). You can also configure the HTTP response code, body, and more.",
  version: "0.1.1",
  type: "source",
  props: {
    httpInterface: {
      type: "$.interface.http",
      customResponse: true,
    },
    emitBodyOnly: {
      type: "boolean",
      label: "Body Only",
      description: "This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.",
      optional: true,
      default: false,
    },
    resStatusCode: {
      type: "string",
      label: "Response Status Code",
      description: "The status code to return in the HTTP response",
      optional: true,
      default: "200",
    },
    resContentType: {
      type: "string",
      label: "Response Content-Type",
      description: "The `Content-Type` of the body returned in the HTTP response",
      optional: true,
      default: "application/json",
    },
    resBody: {
      type: "string",
      label: "Response Body",
      description: "The body to return in the HTTP response",
      optional: true,
      default: "{ \"success\": true }",
    },
    http,
  },
  async run(event) {
    const summary = `${event.method} ${event.path}`;

    this.httpInterface.respond({
      status: this.resStatusCode,
      body: this.resBody,
      headers: {
        "content-type": this.resContentType,
      },
    });

    if (this.emitBodyOnly) {
      this.$emit(event.body, {
        summary,
      });
    } else {
      this.$emit(event, {
        summary,
      });
    }
  },
};

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
N/A	`httpInterface`	`$.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.
Body Only	`emitBodyOnly`	`boolean`	This source emits an event representing the full HTTP request by default. Select `true` to emit the body only.
Response Status Code	`resStatusCode`	`string`	The status code to return in the HTTP response
Response Content-Type	`resContentType`	`string`	The `Content-Type` of the body returned in the HTTP response
Response Body	`resBody`	`string`	The body to return in the HTTP response
HTTP / Webhook	`http`	`app`	This component uses the HTTP / Webhook app.

Trigger Authentication#

The HTTP / Webhook API does not require authentication.

About HTTP / Webhook#

Get a unique URL where you can send HTTP or webhook requests

Action#

Send Fax on Telnyx

Description:Sends a PDF document to a specified fax number using the Telnyx Fax API. [See the documentation](https://developers.telnyx.com/api/programmable-fax/send-fax)

Version:0.0.1

Key:telnyx-send-fax

View on GitHub

Telnyx Overview#

The Telnyx API offers a suite of telecommunication features enabling developers to manage voice, SMS, and other real-time communications. With Telnyx, you can programmatically send and receive text messages, handle voice calls, and control other telephony services using their robust API. Leveraging Pipedream's capabilities, this API can be hooked into workflows to automate complex tasks, react to incoming messages or calls, and integrate with countless other services for analytics, customer support, and more.

Action Code#

import telnyxApp from "../../telnyx.app.mjs";
import constants from "../../common/constants.mjs";

export default {
  key: "telnyx-send-fax",
  name: "Send Fax",
  description: "Sends a PDF document to a specified fax number using the Telnyx Fax API. [See the documentation](https://developers.telnyx.com/api/programmable-fax/send-fax)",
  version: "0.0.1",
  type: "action",
  props: {
    telnyxApp,
    faxAppId: {
      propDefinition: [
        telnyxApp,
        "faxAppId",
      ],
    },
    mediaUrl: {
      type: "string",
      label: "Media URL",
      description: "The URL to the PDF used for the fax's media.",
    },
    phoneNumber: {
      propDefinition: [
        telnyxApp,
        "phoneNumber",
      ],
    },
    to: {
      type: "string",
      label: "To",
      description: "The phone number, in E.164 format, the fax will be sent to or SIP URI",
    },
    fromDisplayName: {
      type: "string",
      label: "From Display Name",
      description: "The string to be used as the caller id name (SIP From Display Name) presented to the destination (to number).",
      optional: true,
    },
    quality: {
      type: "string",
      label: "Quality",
      description: "The quality of the fax. The `ultra` settings provides the highest quality available, but also present longer fax processing times. `ultra_light` is best suited for images, while `ultra_dark` is best suited for text.",
      optional: true,
      options: Object.values(constants.faxQualities),
    },
    ts38Enabled: {
      type: "boolean",
      label: "TS38 Enabled",
      description: "The flag to disable the T.38 protocol",
      optional: true,
    },
    monochrome: {
      type: "boolean",
      label: "Monochrome",
      description: "The flag to enable monochrome, `true` creates black and white fax results.",
      optional: true,
    },
    storeMedia: {
      type: "boolean",
      label: "Store Media",
      description: "Should fax media be stored on temporary URL?",
      optional: true,
    },
    webhookUrl: {
      type: "string",
      label: "Webhook URL",
      description: "Use this field to override the URL to which Telnyx will send subsequent webhooks for this fax.",
      optional: true,
    },
  },
  async run({ $ }) {
    const response = await this.telnyxApp.sendFax({
      $,
      data: {
        connection_id: this.faxAppId,
        media_url: this.mediaUrl,
        from: this.phoneNumber,
        to: this.to,
        from_display_name: this.fromDisplayName,
        quality: this.quality,
        ts38_enabled: this.ts38Enabled,
        monochrome: this.monochrome,
        store_media: this.storeMedia,
        webhook_url: this.webhookUrl,
      },
    });
    $.export("$summary", `Successfully sent fax with Id: ${response.data.id}`);
    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
Telnyx	`telnyxApp`	`app`	This component uses the Telnyx app.
Fax Application ID	`faxAppId`	`string`	Select a value from the drop down menu.
Media URL	`mediaUrl`	`string`	The URL to the PDF used for the fax's media.
Phone Number	`phoneNumber`	`string`	Select a value from the drop down menu.
To	`to`	`string`	The phone number, in E.164 format, the fax will be sent to or SIP URI
From Display Name	`fromDisplayName`	`string`	The string to be used as the caller id name (SIP From Display Name) presented to the destination (to number).
Quality	`quality`	`string`	Select a value from the drop down menu:`normalhighvery_highultra_lightultra_dark`
TS38 Enabled	`ts38Enabled`	`boolean`	The flag to disable the T.38 protocol
Monochrome	`monochrome`	`boolean`	The flag to enable monochrome, `true` creates black and white fax results.
Store Media	`storeMedia`	`boolean`	Should fax media be stored on temporary URL?
Webhook URL	`webhookUrl`	`string`	Use this field to override the URL to which Telnyx will send subsequent webhooks for this fax.

Action Authentication#

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

The Telnyx API V2 uses API Keys to authenticate requests. You can view and manage your API Keys by logging into your Mission Control Portal account and navigating to the Auth V2 tab in the "Auth" section. See docs.

About Telnyx#

Connectivity Made Simple

More Ways to Connect Telnyx + HTTP / Webhook#

Other Popular Integrations#

Send any HTTP Request with HTTP / Webhook API on New Call Received from Telnyx API

Telnyx + HTTP / Webhook