Add or Update Contact with Yespo API on New Submission from Typeform API

Pipedream makes it easy to connect APIs for Yespo, Typeform and 2,400+ other apps remarkably fast.

Trigger workflow on

New Submission from the Typeform API

Next, do this

Add or Update Contact with the Yespo 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 Yespo 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 Add or Update Contact action
1. Connect your Yespo account
2. Optional- Configure First Name
3. Optional- Configure Last Name
4. Configure Channels
5. Optional- Configure Region
6. Optional- Configure Town
7. Optional- Configure Address
8. Optional- Configure Postcode
9. Optional- Configure Additional Fields
10. Optional- Configure Address Book Id
11. Optional- Select a Contact Id
12. Optional- Configure External Customer Id
13. Optional- Configure Contact Key
14. Optional- Configure Language Code
15. Optional- Configure TimeZone
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#

Add or Update Contact on Yespo

Description:Adds a new contact or updates an existing one. [See the documentation](https://docs.yespo.io/reference/addcontact-1)

Version:0.0.1

Key:yespo-add-update-contact

View on GitHub

Yespo Overview#

The Yespo API offers a platform for personalized customer engagement through multichannel marketing automation. By integrating Yespo with Pipedream, you can create custom workflows that trigger based on customer interactions or data changes. This allows for dynamic campaign management, customer segmentation, and real-time analytics, enabling you to automate and scale personalized marketing efforts efficiently.

Action Code#

import { parseObject } from "../../common/utils.mjs";
import yespo from "../../yespo.app.mjs";

export default {
  key: "yespo-add-update-contact",
  name: "Add or Update Contact",
  description: "Adds a new contact or updates an existing one. [See the documentation](https://docs.yespo.io/reference/addcontact-1)",
  version: "0.0.1",
  type: "action",
  props: {
    yespo,
    firstName: {
      type: "string",
      label: "First Name",
      description: "Contact's first name.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Contact's last name.",
      optional: true,
    },
    channels: {
      type: "string[]",
      label: "Channels",
      description: "Channels for the contact. For example: `[ { \"device\": { \"appId\": \"83b77a49-fc28-409b-aeaa-68c9d544ab9d\", \"deviceModel\": \"iPhone\", \"os\": \"iOS\", \"locale\": \"en_UK\", \"clientVersion\": \"native\", \"appVersion\": \"1.23.45\", \"active\": true }, \"type\": \"email\", \"value\": \"pipedream@test.com\" } ]`. [See the documentation to further information](https://docs.yespo.io/reference/addcontact-1)",
    },
    addressRegion: {
      type: "string",
      label: "Region",
      description: "The address region.",
      optional: true,
    },
    addressTown: {
      type: "string",
      label: "Town",
      description: "The address city.",
      optional: true,
    },
    address: {
      type: "string",
      label: "Address",
      description: "The address line.",
      optional: true,
    },
    addressPostcode: {
      type: "string",
      label: "Postcode",
      description: "Postal/ZIP code.",
      optional: true,
    },
    additionalFields: {
      type: "object",
      label: "Additional Fields",
      description: "Values of the additional fields for a contact. Keys are additional field ID.",
      optional: true,
    },
    addressBookId: {
      type: "string",
      label: "Address Book Id",
      description: "The address book unique identifier.",
      optional: true,
    },
    contactId: {
      propDefinition: [
        yespo,
        "contactId",
      ],
      optional: true,
    },
    externalCustomerId: {
      type: "string",
      label: "External Customer Id",
      description: "External contact id.",
      optional: true,
    },
    contactKey: {
      type: "string",
      label: "Contact Key",
      description: "Contact's key.",
      optional: true,
    },
    languageCode: {
      type: "string",
      label: "Language Code",
      description: "Language code for the contact.",
      optional: true,
    },
    timeZone: {
      type: "string",
      label: "TimeZone",
      description: "The contact's time zone. See [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).",
      optional: true,
    },
  },
  async run({ $ }) {
    const fields = [];
    if (this.additionalFields) {
      for (const [
        key,
        value,
      ] of Object.entries(this.additionalFields)) {
        fields.push({
          [key]: value,
        });
      }
    }

    const data = {
      firstName: this.firstName,
      lastName: this.lastName,
      channels: this.channels && parseObject(this.channels),
      address: {
        region: this.addressRegion,
        town: this.addressTown,
        address: this.address,
        postcode: this.addressPostcode,
      },
      addressBookId: this.addressBookId,
      contactId: this.contactId,
      externalCustomerId: this.externalCustomerId,
      contactKey: this.contactKey,
      languageCode: this.languageCode,
      timeZone: this.timeZone,
      fields,
    };

    const response = await this.yespo.addOrUpdateContact({
      $,
      data,
    });
    $.export("$summary", `Successfully added or updated the contact 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.

Label	Prop	Type	Description
Yespo	`yespo`	`app`	This component uses the Yespo app.
First Name	`firstName`	`string`	Contact's first name.
Last Name	`lastName`	`string`	Contact's last name.
Channels	`channels`	`string[]`	Channels for the contact. For example: `[ { "device": { "appId": "83b77a49-fc28-409b-aeaa-68c9d544ab9d", "deviceModel": "iPhone", "os": "iOS", "locale": "en_UK", "clientVersion": "native", "appVersion": "1.23.45", "active": true }, "type": "email", "value": "pipedream@test.com" } ]`. See the documentation to further information
Region	`addressRegion`	`string`	The address region.
Town	`addressTown`	`string`	The address city.
Address	`address`	`string`	The address line.
Postcode	`addressPostcode`	`string`	Postal/ZIP code.
Additional Fields	`additionalFields`	`object`	Values of the additional fields for a contact. Keys are additional field ID.
Address Book Id	`addressBookId`	`string`	The address book unique identifier.
Contact Id	`contactId`	`string`	Select a value from the drop down menu.
External Customer Id	`externalCustomerId`	`string`	External contact id.
Contact Key	`contactKey`	`string`	Contact's key.
Language Code	`languageCode`	`string`	Language code for the contact.
TimeZone	`timeZone`	`string`	The contact's time zone. See TZ database name.