Create Contact with Project Broadcast API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for Project Broadcast, Typeform and 2,900+ other apps remarkably fast.

Trigger workflow on

New Submission from the Typeform API

Next, do this

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

Select this integration
Configure the New Submission trigger
1. Connect your Typeform account
2. Select a Form
Configure the Create Contact action
1. Connect your Project Broadcast account
2. Configure Phone Number
3. Optional- Configure Email
4. Optional- Configure First Name
5. Optional- Configure Last Name
6. Optional- Configure Company Name
7. Optional- Configure Birthday
8. Optional- Configure Anniversary
9. Optional- Configure Notes
10. Optional- Configure Tags
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 Submission on Typeform

Description:Emit new submission

Version:0.0.8

Key:typeform-new-submission

View on GitHub

Typeform Overview#

The Typeform API furnishes you with the means to create dynamic forms and collect user responses in real-time. By leveraging this API within Pipedream's serverless platform, you can automate workflows to process this data, integrate seamlessly with other services, and react to form submissions instantaneously. This empowers you to craft tailored responses, synchronize with databases, trigger email campaigns, or even manage event registrations without manual intervention.

Trigger Code#

import { createHmac } from "crypto";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";
import common from "../common/common.mjs";
import constants from "../../constants.mjs";
import utils from "../common/utils.mjs";

const { typeform } = common.props;
const { parseIsoDate } = utils;

export default {
  ...common,
  key: "typeform-new-submission",
  name: "New Submission",
  version: "0.0.8",
  type: "source",
  description: "Emit new submission",
  props: {
    ...common.props,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
    formId: {
      propDefinition: [
        typeform,
        "formId",
      ],
    },
  },
  methods: {
    ...common.methods,
    generateSecret() {
      return "" + Math.random();
    },
  },
  hooks: {
    ...common.hooks,
    async activate() {
      const secret = this.generateSecret();
      this._setSecret(secret);

      let tag = this._getTag();
      if (!tag) {
        tag = uuid();
        this._setTag(tag);
      }

      return await this.typeform.createHook({
        endpoint: this.http.endpoint,
        formId: this.formId,
        tag,
        secret,
      });
    },
    async deactivate() {
      const tag = this._getTag();

      return await this.typeform.deleteHook({
        formId: this.formId,
        tag,
      });
    },
  },
  async run(event) {
    const {
      body,
      headers,
    } = event;

    const { [constants.TYPEFORM_SIGNATURE]: typeformSignature } = headers;

    if (typeformSignature) {
      const secret = this._getSecret();

      const hmac =
        createHmac(constants.ALGORITHM, secret)
          .update(body)
          .digest(constants.ENCODING);

      const signature = `${constants.ALGORITHM}=${hmac}`;

      if (typeformSignature !== signature) {
        throw new Error("signature mismatch");
      }
    }

    let formResponseString = "";
    const data = Object.assign({}, body.form_response);
    data.form_response_parsed = {};

    for (let i = 0; i < body.form_response.answers.length; i++) {
      const field = body.form_response.definition.fields[i];
      const answer = body.form_response.answers[i];

      let parsedAnswer;
      let value = answer[answer.type];

      if (value.label) {
        parsedAnswer = value.label;

      } else if (value.labels) {
        parsedAnswer = value.labels.join();

      } else if (value.choice) {
        parsedAnswer = value.choice;

      } else if (value.choices) {
        parsedAnswer = value.choices.join();

      } else {
        parsedAnswer = value;
      }

      data.form_response_parsed[field.title] = parsedAnswer;
      formResponseString += `### ${field.title}\n${parsedAnswer}\n`;
    }

    data.form_response_string = formResponseString;
    data.raw_webhook_event = body;

    if (data.landed_at) {
      data.landed_at = parseIsoDate(data.landed_at);
    }

    if (data.submitted_at) {
      data.submitted_at = parseIsoDate(data.submitted_at);
    }

    data.form_title = body.form_response.definition.title;
    delete data.answers;
    delete data.definition;

    this.$emit(data, {
      summary: JSON.stringify(data),
      id: data.token,
    });

    this.http.respond({
      status: 200,
    });
  },
  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
Typeform	`typeform`	`app`	This component uses the Typeform 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.
Form	`formId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

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

offlineaccounts:readforms:writeforms:readimages:writeimages:readthemes:writethemes:readresponses:readresponses:writewebhooks:readwebhooks:writeworkspaces:readworkspaces:write

About Typeform#

Typeform lets you build no-code forms, quizzes, and surveys - and get more responses.

Action#

Create Contact on Project Broadcast

Description:Create a new contact. [See the documentation](https://www.projectbroadcast.com/apidoc/#api-Contacts-CreateContact)

Version:0.0.3

Key:project_broadcast-create-contact

View on GitHub

Project Broadcast Overview#

The Project Broadcast API facilitates communication through automated text messaging, providing features to manage contacts, send messages, and track campaigns. Leveraging this API on Pipedream allows you to create intricate workflows that can automate your texting campaigns, sync contact lists, and engage with customers by integrating with numerous other services for CRM, marketing, and other functions. With Pipedream's serverless platform, these integrations become seamless, triggering actions in real-time or on a schedule without the need for complex infrastructure.

Action Code#

import app from "../../project_broadcast.app.mjs";
export default {
  key: "project_broadcast-create-contact",
  name: "Create Contact",
  description: "Create a new contact. [See the documentation](https://www.projectbroadcast.com/apidoc/#api-Contacts-CreateContact)",
  type: "action",
  version: "0.0.3",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    app,
    phoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "The phone number of the contact.",
    },
    email: {
      type: "string",
      label: "Email",
      description: "The email of the contact.",
      optional: true,
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "The first name of the contact.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "The last name of the contact.",
      optional: true,
    },
    company: {
      type: "string",
      label: "Company Name",
      description: "The company name of the contact.",
      optional: true,
    },
    birthday: {
      type: "string",
      label: "Birthday",
      description: "The birthday of the contact. The format should be `MM-DD`.",
      optional: true,
    },
    anniversary: {
      type: "string",
      label: "Anniversary",
      description: "The anniversary of the contact. The format should be `MM-DD`.",
      optional: true,
    },
    notes: {
      type: "string",
      label: "Notes",
      description: "Notes for the contact.",
      optional: true,
    },
    tags: {
      type: "string[]",
      label: "Tags",
      description: "Tags for the contact.",
      optional: true,
    },
  },
  methods: {
    createContact(args = {}) {
      return this.app.post({
        path: "/contacts",
        ...args,
      });
    },
  },
  run({ $: step }) {
    const {
      // eslint-disable-next-line no-unused-vars
      app,
      createContact,
      ...data
    } = this;

    return createContact({
      step,
      data,
      summary: (response) => `Successfully created contact with ID \`${response._id}.\``,
    });
  },
};

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
Project Broadcast	`app`	`app`	This component uses the Project Broadcast app.
Phone Number	`phoneNumber`	`string`	The phone number of the contact.
Email	`email`	`string`	The email of the contact.
First Name	`firstName`	`string`	The first name of the contact.
Last Name	`lastName`	`string`	The last name of the contact.
Company Name	`company`	`string`	The company name of the contact.
Birthday	`birthday`	`string`	The birthday of the contact. The format should be `MM-DD`.
Anniversary	`anniversary`	`string`	The anniversary of the contact. The format should be `MM-DD`.
Notes	`notes`	`string`	Notes for the contact.
Tags	`tags`	`string[]`	Tags for the contact.

Action Authentication#

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

To retrieve your API Key,

Navigate to your Project Broadcast account and sign in
Click the “More” menu with the three horizontal lines glyph on the left navitation
Go to “ACCOUNT” > “Get Api Key”