Create Contact with RingCentral API on New Topic Webhook from QStash API

Pipedream makes it easy to connect APIs for RingCentral, QStash and 2,800+ other apps remarkably fast.

Trigger workflow on

New Topic Webhook from the QStash API

Next, do this

Create Contact with the RingCentral 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 QStash trigger and RingCentral action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Topic Webhook trigger
1. Connect your QStash account
2. Select a QStash Topic
Configure the Create Contact action
1. Connect your RingCentral account
2. Configure Account ID
3. Select one or more Extensions
4. Optional- Configure Email
5. Optional- Configure First Name
6. Optional- Configure Last Name
7. Optional- Configure Mobile Phone
8. Optional- Configure Additional Options
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 Topic Webhook on QStash

Description:Emit new events on each new QStash topic message

Version:0.0.1

Key:qstash-new-topic-webhook

View on GitHub

QStash Overview#

QStash API offers a secure, scalable, and simple way to manage message queues and defer tasks. Using this API, you can enqueue messages, schedule tasks to run after a delay, and ensure that tasks are executed exactly once, leveraging the power of serverless architecture. With Pipedream's ability to connect to a multitude of services, you can build complex workflows that trigger actions in other apps based on events in QStash, allowing you to automate cross-application business processes with ease.

Trigger Code#

import qstash from "../../qstash.app.mjs";
import { methods } from "../../common.mjs";

export default {
  name: "New Topic Webhook",
  version: "0.0.1",
  key: "qstash-new-topic-webhook",
  description: "Emit new events on each new QStash topic message",
  props: {
    qstash,
    topicId: {
      type: "string",
      label: "QStash Topic",
      description: "The QStash topic to subscribe to.",
      async options() {
        const topics = await this.qstash.listTopics({
          $: this,
        });

        return topics.map((topic) => ({
          label: topic.name,
          value: topic.topicId,
        }));
      },
    },
    http: {
      type: "$.interface.http",
      customResponse: true, // optional: defaults to false
    },
    db: "$.service.db",
  },
  type: "source",
  methods: {
    ...methods,
  },
  hooks: {
    async deploy() {
      console.log("deployment hook started");
      console.log("selected topic ID", this.topicId);
      console.log(`PD generated endpoint URL ${this.http.endpoint}`);
      const endpoint = await this.qstash.createEndpoint({
        $: this,
        topicId: this.topicId,
        endpointUrl: this.http.endpoint,
      });
      console.log("Created endpoint", endpoint);
      this.db.set("endpointId", endpoint.endpointId);
    },
    async deactivate() {
      console.log("deactivate hook started");
      const endpointId = this.db.get("endpointId");
      await this.qstash.deleteEndpoint({
        $: this,
        endpointId,
      });
      console.log(`Deleted QStash endpoint ${endpointId}`);
    },
    async activate() {
      console.log("activate hook started");

      const keys = await this.qstash.getKeys({
        $: this,
      });

      const currentSigningKey = keys.current;
      const nextSigningKey = keys.next;

      this.db.set("currentSigningKey", currentSigningKey);
      this.db.set("nextSigningKey", nextSigningKey);
      console.log("Set QStash signing keys");
    },
  },
  async run(event) {
    const signature = event.headers["upstash-signature"];
    const currentSigningKey = this.db.get("currentSigningKey");
    const nextSigningKey = this.db.get("nextSigningKey");
    const url = event.url.slice(0, -1);

    try {
      await this.verify(signature, currentSigningKey, event.rawBody, url);
    } catch (e) {
      console.log(e);
      await this.verify(signature, nextSigningKey, event.rawBody, url);
    }

    await this.$emit(
      {
        event,
      },
      {
        id: event.headers["upstash-signature"],
        summary: "New webhook received from QStash",
        ts: Date.now(),
      },
    );

    await this.http.respond({
      status: 200,
    });
  },
};

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
QStash	`qstash`	`app`	This component uses the QStash app.
QStash Topic	`topicId`	`string`	Select a value from the drop down menu.
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.

Trigger Authentication#

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

Retrieve your QStash token

Open the QStash console
Copy the QSTASH_TOKEN from the Request Builder

Click REQUEST_TOKEN within the Request builder to copy the token to your clipboard

Then paste it in the field below.

About QStash#

QStash is an HTTP based messaging and scheduling solution for the serverless and edge runtimes.

Action#

Create Contact on RingCentral

Description:Creates a user personal contact. [See the documentation](https://developers.ringcentral.com/api-reference/External-Contacts/createContact)

Version:0.0.1

Key:ringcentral-create-contact

View on GitHub

RingCentral Overview#

RingCentral is a comprehensive cloud communication platform that melds messaging, video, and phone services. Integrating RingCentral with Pipedream allows for automated workflows involving SMS sending, call management, and leveraging communication logs for data-driven insights. With Pipedream's serverless execution model, you can trigger actions based on specific RingCentral events or schedule tasks to run at predetermined intervals, all without writing extensive code.

Action Code#

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

export default {
  key: "ringcentral-create-contact",
  name: "Create Contact",
  description: "Creates a user personal contact. [See the documentation](https://developers.ringcentral.com/api-reference/External-Contacts/createContact)",
  version: "0.0.1",
  type: "action",
  props: {
    ringcentral,
    accountId: {
      propDefinition: [
        ringcentral,
        "accountId",
      ],
    },
    extensionId: {
      propDefinition: [
        ringcentral,
        "extensionId",
      ],
      description: "Internal identifier of the RingCentral extension/user",
    },
    email: {
      type: "string",
      label: "Email",
      description: "Email address of the contact",
      optional: true,
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "First name of the contact",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Last name of the contact",
      optional: true,
    },
    mobilePhone: {
      type: "string",
      label: "Mobile Phone",
      description: "Mobile phone of the contact",
      optional: true,
    },
    additionalOptions: {
      type: "object",
      label: "Additional Options",
      description: "Additional parameters to set for the contact. [See the documentation](https://developers.ringcentral.com/api-reference/External-Contacts/createContact) for all available parameters. Values will be parsed as JSON where applicable. Example: `{ \"notes\": \"Notes for the contact\" }`",
      optional: true,
    },
  },
  methods: {
    createContact({
      accountId, extensionId, ...args
    }) {
      return this.ringcentral.makeRequest({
        method: "POST",
        path: `/account/${accountId}/extension/${extensionId}/address-book/contact`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const { // eslint-disable-next-line no-unused-vars
      ringcentral, createContact, accountId, extensionId, additionalOptions, ...data
    } = this;

    const response =
      await createContact({
        $,
        accountId,
        extensionId,
        data: {
          ...data,
          ...(additionalOptions && utils.parseObjectEntries(additionalOptions)),
        },
      });

    $.export("$summary", `Successfully created contact (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.

Label	Prop	Type	Description
RingCentral	`ringcentral`	`app`	This component uses the RingCentral app.
Account ID	`accountId`	`string`	Internal identifier of a RingCentral account or tilde (`~`) to indicate the account logged-in within the current session.
Extensions	`extensionId`	`string[]`	Select a value from the drop down menu.
Email	`email`	`string`	Email address of the contact
First Name	`firstName`	`string`	First name of the contact
Last Name	`lastName`	`string`	Last name of the contact
Mobile Phone	`mobilePhone`	`string`	Mobile phone of the contact
Additional Options	`additionalOptions`	`object`	Additional parameters to set for the contact. See the documentation for all available parameters. Values will be parsed as JSON where applicable. Example: `{ "notes": "Notes for the contact" }`

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:

Create Contact with RingCentral API on New Topic Webhook from QStash API

Pipedream makes it easy to connect APIs for RingCentral, QStash and 2,800+ other apps remarkably fast.

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

Developers ♥ Pipedream

Retrieve your QStash token

1-24of2,800+apps by most popular

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