Send and Track Postcard or Letter with Postalytics API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Send and Track Postcard or Letter with the Postalytics 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 Postalytics 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 Send and Track Postcard or Letter action
1. Connect your Postalytics account
2. Configure First Name
3. Configure Last Name
4. Optional- Configure Company
5. Optional- Configure Phone
6. Configure Address Street
7. Configure Address Street 2
8. Configure Address City
9. Configure Address State
10. Configure Address Zip
11. Optional- Configure Email Address
12. Optional- Configure Var Field 1
13. Optional- Configure Var Field 2
14. Optional- Configure Var Field 3
15. Optional- Configure Var Field 4
16. Optional- Configure Var Field 5
17. Optional- Configure Var Field 6
18. Optional- Configure Var Field 7
19. Optional- Configure Var Field 8
20. Optional- Configure Var Field 9
21. Optional- Configure Var Field 10
22. Select a Campaign ID
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#

Send and Track Postcard or Letter on Postalytics

Description:Send a postcard or letter with the capability of tracking delivery and response. [See the documentation](https://postalytics.docs.apiary.io/)

Version:0.0.1

Key:postalytics-send-track-postcard-letter

View on GitHub

Postalytics Overview#

The Postalytics API lets you automate direct mail marketing campaigns, manage contacts, and track results. By integrating Postalytics with Pipedream, you can build serverless workflows that leverage your marketing stack, sync data across platforms, and personalize your outreach efforts. You can trigger direct mail pieces based on customer behavior, update your CRM with mailing results, or create custom analytics dashboards.

Action Code#

import common from "../common/base.mjs";

export default {
  ...common,
  key: "postalytics-send-track-postcard-letter",
  name: "Send and Track Postcard or Letter",
  description: "Send a postcard or letter with the capability of tracking delivery and response. [See the documentation](https://postalytics.docs.apiary.io/)",
  version: "0.0.1",
  type: "action",
  props: {
    ...common.props,
    campaignId: {
      propDefinition: [
        common.props.postalytics,
        "campaignId",
      ],
    },
  },
  methods: {
    getFn() {
      return this.postalytics.sendMailPiece;
    },
    getObject({ campaignId }, objToSend) {
      return {
        campaignId,
        ...objToSend,
      };
    },
    getSummary({ campaignId }) {
      return `Sent postcard/letter for campaign ID ${campaignId}.`;
    },
  },
};

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
Postalytics	`postalytics`	`app`	This component uses the Postalytics app.
First Name	`firstName`	`string`	Recipient's first name must be between 1 and 50 characters long.
Last Name	`lastName`	`string`	Recipient's last name must be between 1 and 50 characters long.
Company	`company`	`string`	If provided, can be up to 100 characters long.
Phone	`phone`	`string`	If provided, can be up to 100 characters long.
Address Street	`addressStreet`	`string`	Recipient's street, can be up to 100 characters long.
Address Street 2	`addressStreet2`	`string`	Recipient's street2, can be up to 100 characters long.
Address City	`addressCity`	`string`	Recipient's address, can be up to 100 characters long.
Address State	`addressState`	`string`	Recipient's state, must be a 2 letter state short-name code or a valid full state name.
Address Zip	`addressZip`	`string`	Recipient's zip code, must be in valid zip format.
Email Address	`emailAddress`	`string`	Recipient's email address up to 100 characters long
Var Field 1	`varField1`	`string`	Any string up to 255 characters
Var Field 2	`varField2`	`string`	Any string up to 255 characters
Var Field 3	`varField3`	`string`	Any string up to 255 characters
Var Field 4	`varField4`	`string`	Any string up to 255 characters
Var Field 5	`varField5`	`string`	Any string up to 255 characters
Var Field 6	`varField6`	`string`	Any string up to 255 characters
Var Field 7	`varField7`	`string`	Any string up to 255 characters
Var Field 8	`varField8`	`string`	Any string up to 255 characters
Var Field 9	`varField9`	`string`	Any string up to 255 characters
Var Field 10	`varField10`	`string`	Any string up to 255 characters
Campaign ID	`campaignId`	`string`	Select a value from the drop down menu.