← HTTP / Webhook + RingCentral integrations

Send SMS with RingCentral API on New Requests from HTTP / Webhook API

Pipedream makes it easy to connect APIs for RingCentral, HTTP / Webhook and 800+ other apps remarkably fast.

Trigger workflow on
New Requests from the HTTP / Webhook API
Next, do this
Send SMS with the RingCentral API
No credit card required
Into to Pipedream
Watch us build a workflow
Watch us build a workflow
7 min
Watch now ➜
Trusted by 250,000+ developers from startups to Fortune 500 companies:
Trusted by 250,000+ developers from startups to Fortune 500 companies

Developers Pipedream

Getting Started

This integration creates a workflow with a HTTP / Webhook trigger and RingCentral 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 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
  3. Configure the Send SMS action
    1. Connect your RingCentral account
    2. Configure Account ID
    3. Select one or more Extensions
    4. Configure Phone Number
    5. Configure To Phone Numbers
    6. Configure text
    7. Optional- Select a Country ID
  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: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

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.
LabelPropTypeDescription
N/AhttpInterface$.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.
Body OnlyemitBodyOnlyboolean

This source emits an event representing the full HTTP request by default. Select true to emit the body only.

Response Status CoderesStatusCodestring

The status code to return in the HTTP response

Response Content-TyperesContentTypestring

The Content-Type of the body returned in the HTTP response

Response BodyresBodystring

The body to return in the HTTP response

HTTP / WebhookhttpappThis 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

Description:Creates and sends a new text message. See the API docs [here](https://developers.ringcentral.com/api-reference/SMS/createSMSMessage)
Version:0.5.0
Key:ringcentral-send-sms

Action Code

import ringcentral from "../../ringcentral.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "ringcentral-send-sms",
  name: "Send SMS",
  description: "Creates and sends a new text message. See the API docs [here](https://developers.ringcentral.com/api-reference/SMS/createSMSMessage)",
  version: "0.5.0",
  type: "action",
  props: {
    ringcentral,
    accountId: {
      propDefinition: [
        ringcentral,
        "accountId",
      ],
    },
    extensionId: {
      propDefinition: [
        ringcentral,
        "extensionId",
      ],
      description: "Internal identifier of an extension.",
    },
    fromPhoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "The phoneNumber for the sender of an SMS message. Property must be filled to correspond to one of the account phone numbers which is allowed to send SMS. Phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164#Numbering_formats) e.g. `+16502223366`.",
    },
    toPhoneNumbers: {
      type: "string[]",
      label: "To Phone Numbers",
      description: "Phone number of receiver(s) of an SMS message. Phone number in [E.164 format](https://en.wikipedia.org/wiki/E.164#Numbering_formats) e.g. `+16502223366`.",
    },
    text: {
      type: "string",
      description: "Text of a message. Max length is 1000 symbols (2-byte [UTF-16](https://en.wikipedia.org/wiki/UTF-16) encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 500 symbols.",
    },
    countryId: {
      propDefinition: [
        ringcentral,
        "countryId",
      ],
    },
  },
  async run({ $ }) {
    const {
      accountId,
      extensionId,
      fromPhoneNumber,
      text,
      countryId,
    } = this;

    const toPhoneNumbers = utils.parse(this.toPhoneNumbers);
    const to = toPhoneNumbers.map((phoneNumber) => ({
      phoneNumber,
    }));

    const response =
      await this.ringcentral.sendSMS({
        $,
        accountId,
        extensionId,
        data: {
          from: {
            phoneNumber: fromPhoneNumber,
          },
          to,
          text,
          country: utils.emptyObjectToUndefined({
            id: countryId,
          }),
        },
      });

    $.export("$summary", `Successfully sent SMS with ID ${response.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.

LabelPropTypeDescription
RingCentralringcentralappThis component uses the RingCentral app.
Account IDaccountIdstring

Internal identifier of a RingCentral account or tilde (~) to indicate the account logged-in within the current session.

ExtensionsextensionIdstring[]Select a value from the drop down menu.
Phone NumberfromPhoneNumberstring

The phoneNumber for the sender of an SMS message. Property must be filled to correspond to one of the account phone numbers which is allowed to send SMS. Phone number in E.164 format e.g. +16502223366.

To Phone NumberstoPhoneNumbersstring[]

Phone number of receiver(s) of an SMS message. Phone number in E.164 format e.g. +16502223366.

texttextstring

Text of a message. Max length is 1000 symbols (2-byte UTF-16 encoded). If a character is encoded in 4 bytes in UTF-16 it is treated as 2 characters, thus restricting the maximum message length to 500 symbols.

Country IDcountryIdstringSelect a value from the drop down menu.

Action Authentication

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

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

About RingCentral

Business communications platform

More Ways to Connect RingCentral + HTTP / Webhook