Create Event with UserSketch API on New Incoming SMS (Instant) from Twilio API

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

Trigger workflow on

New Incoming SMS (Instant) from the Twilio API

Next, do this

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

Select this integration
Configure the New Incoming SMS (Instant) trigger
1. Connect your Twilio account
2. Select a Incoming Phone Number
3. Optional- Configure Response Message
Configure the Create Event action
1. Connect your UserSketch account
2. Configure Email
3. Select a Event type
4. Optional- Configure Date
5. Configure Link
6. Configure Message
7. Configure Subject
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 Incoming SMS (Instant) on Twilio

Description:Emit new event every time an SMS is sent to the phone number set. Configures a webhook in Twilio, tied to an incoming phone number.

Version:0.1.4

Key:twilio-new-incoming-sms

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.

Trigger Code#

import twilio from "twilio";
import common from "../common/common-webhook.mjs";
import constants from "../../common/constants.mjs";

const MessagingResponse = twilio.twiml.MessagingResponse;

export default {
  ...common,
  key: "twilio-new-incoming-sms",
  name: "New Incoming SMS (Instant)",
  description: "Emit new event every time an SMS is sent to the phone number set. Configures a webhook in Twilio, tied to an incoming phone number.",
  version: "0.1.4",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    responseMessage: {
      propDefinition: [
        common.props.twilio,
        "responseMessage",
      ],
    },
  },
  methods: {
    ...common.methods,
    getServiceType() {
      return constants.SERVICE_TYPE.SMS;
    },
    getResponseBody() {
      const twiml = new MessagingResponse();
      let responseBody = "<Response></Response>";
      if (this.responseMessage) {
        twiml.message(this.responseMessage);
        responseBody = twiml.toString();
      }
      return responseBody;
    },
    generateMeta(body, headers) {
      return {
        /** if Twilio retries a message, but we've already emitted, dedupe */
        id: headers["i-twilio-idempotency-token"],
        summary: body.Body,
        ts: Date.now(),
      };
    },
  },
};

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
Twilio	`twilio`	`app`	This component uses the Twilio app.
Incoming Phone Number	`incomingPhoneNumber`	`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.
Response Message	`responseMessage`	`string`	The message you want to send in response to incoming messages. Leave this blank if you don't need to issue a response.

Trigger 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.

Action#

Create Event on UserSketch

Description:Create an event. [See the documentation](https://usersketch.readme.io/reference/post_api-customer-event-create)

Version:0.0.11

Key:usersketch-create-event

View on GitHub

UserSketch Overview#

The UserSketch API lets you pull user details like names, emails, locations, and job titles, to create realistic user personas for your apps or services. Integrating the UserSketch API with Pipedream unlocks the potential to automate the creation of these personas, enrich CRM data, or enhance user testing with minimal effort. Pipedream's serverless platform facilitates the creation of complex workflows, connecting UserSketch with a vast array of other apps and services to streamline your processes.

Action Code#

import app from "../../usersketch.app.mjs";
import constants from "../common/constants.mjs";

export default {
  name: "Create Event",
  version: "0.0.11",
  key: "usersketch-create-event",
  description: "Create an event. [See the documentation](https://usersketch.readme.io/reference/post_api-customer-event-create)",
  type: "action",
  props: {
    app,
    email: {
      type: "string",
      label: "Email",
      description: "Email of the user",
    },
    eventType: {
      type: "string",
      label: "Event type",
      description: "Type of the event",
      options: constants.EVENT_TYPES,
    },
    date: {
      type: "string",
      label: "Date",
      description: "The time when the event occurred. Can be in Unix timestamp or ISO8601 format, for example, `2023-12-08T10:00:00+07:00`",
      optional: true,
    },
    link: {
      type: "string",
      label: "Link",
      description: "The link to the event",
    },
    message: {
      type: "string",
      label: "Message",
      description: "The note or email's HTML or text body",
    },
    subject: {
      type: "string",
      label: "Subject",
      description: "The subject of the email",
    },
  },
  async run({ $ }) {
    const date = !this.date
      ? Math.floor(Date.now() / 1000)
      : Math.floor((new Date(this.date.length === 10
        ? +this.date * 1000
        : this.date)).getTime() / 1000);

    const response = await this.app.createEvent({
      $,
      data: {
        customerData: {
          email: this.email,
        },
        eventData: {
          eventType: this.eventType,
          date,
          link: this.link,
          message: this.message,
          subject: this.subject,
        },
      },
    });

    if (response.success) {
      $.export("$summary", "Successfully created event");
    }

    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
UserSketch	`app`	`app`	This component uses the UserSketch app.
Email	`email`	`string`	Email of the user
Event type	`eventType`	`string`	Select a value from the drop down menu:`{ "label": "Email", "value": "email" }{ "label": "Chat", "value": "chat" }{ "label": "Phone call", "value": "phone_call" }{ "label": "SMS", "value": "sms" }{ "label": "Payment information", "value": "payment_information" }{ "label": "Note", "value": "note" }`
Date	`date`	`string`	The time when the event occurred. Can be in Unix timestamp or ISO8601 format, for example, `2023-12-08T10:00:00+07:00`
Link	`link`	`string`	The link to the event
Message	`message`	`string`	The note or email's HTML or text body
Subject	`subject`	`string`	The subject of the email

Action Authentication#

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

About UserSketch#

CRM platform built with async B2C SaaS teams in mind.

More Ways to Connect UserSketch + Twilio#

Other Popular Integrations#

Create Event with UserSketch API on New Call (Instant) from Twilio API

Twilio + UserSketch