Create Route with Samsara API on New Submission from Typeform API

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

Trigger workflow on

New Submission from the Typeform API

Next, do this

Create Route with the Samsara 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 Samsara 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 Route action
1. Connect your Samsara account
2. Optional- Select a Driver Id
3. Optional- Configure External Ids
4. Configure Name
5. Optional- Configure Notes
6. Optional- Select a Route Completion Condition
7. Optional- Select a Route Starting Condition
8. Configure Stops
9. Optional- Select a Vehicle 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#

Create Route on Samsara

Description:Generates a new route to an existing address. As a prerequisite, the user must create an address using the 'create-address' action if the location is not already available in the address book. The user must provide the necessary props such as destination address.

Version:0.0.1

Key:samsara-create-route

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { parseObject } from "../../common/utils.mjs";
import samsara from "../../samsara.app.mjs";

export default {
  key: "samsara-create-route",
  name: "Create Route",
  description: "Generates a new route to an existing address. As a prerequisite, the user must create an address using the 'create-address' action if the location is not already available in the address book. The user must provide the necessary props such as destination address.",
  version: "0.0.1",
  type: "action",
  props: {
    samsara,
    driverId: {
      propDefinition: [
        samsara,
        "driverId",
      ],
      optional: true,
    },
    externalIds: {
      propDefinition: [
        samsara,
        "externalIds",
      ],
      optional: true,
    },
    name: {
      type: "string",
      label: "Name",
      description: "Name for the route",
    },
    notes: {
      type: "string",
      label: "Notes",
      description: "Notes about the route.",
      optional: true,
    },
    routeCompletionCondition: {
      type: "string",
      label: "Route Completion Condition",
      description: "Defaults to 'arriveLastStop' which ends the route upon arriving at the final stop. The condition 'departLastStop' ends the route upon departing the last stop. If 'arriveLastStop' is set, then the departure time of the final stop should not be set.",
      options: [
        "arriveLastStop",
        "departLastStop",
      ],
      optional: true,
    },
    routeStartingCondition: {
      type: "string",
      label: "Route Starting Condition",
      description: "Defaults to 'departFirstStop' which starts the route upon departing the first stop in the route. The condition 'arriveFirstStop' starts the route upon arriving at the first stop in the route. If 'departFirstStop' is set, the arrival time of the first stop should not be set.",
      options: [
        "departFirstStop",
        "arriveFirstStop",
      ],
      optional: true,
    },
    stops: {
      type: "object",
      label: "Stops",
      description: "List of objects of stops along the route. For each stop, exactly one of addressId and singleUseLocation are required. Depending on the settings on your route, either a scheduledArrivalTime or scheduledDepartureTime must be specified for the first job. [See further information](https://developers.samsara.com/reference/createroute)",
    },
    vehicleId: {
      propDefinition: [
        samsara,
        "vehicleId",
      ],
      optional: true,
    },
  },
  async run({ $ }) {
    try {
      const response = await this.samsara.createRoute({
        $,
        data: {
          driverId: this.driverId,
          externalIds: parseObject(this.externalIds),
          name: this.name,
          notes: this.notes,
          settings: {
            routeCompletionCondition: this.routeCompletionCondition,
            routeStartingCondition: this.routeStartingCondition,
          },
          stops: parseObject(this.stops),
          vehicleId: this.vehicleId,
        },
      });

      $.export("$summary", `Successfully created a new route with Id: ${response.data?.id}`);
      return response;
    } catch ({ message }) {
      throw new ConfigurationError(JSON.parse(message).message);
    }
  },
};

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
Samsara	`samsara`	`app`	This component uses the Samsara app.
Driver Id	`driverId`	`string`	Select a value from the drop down menu.
External Ids	`externalIds`	`object`	The external IDs for the given object.
Name	`name`	`string`	Name for the route
Notes	`notes`	`string`	Notes about the route.
Route Completion Condition	`routeCompletionCondition`	`string`	Select a value from the drop down menu:`arriveLastStopdepartLastStop`
Route Starting Condition	`routeStartingCondition`	`string`	Select a value from the drop down menu:`departFirstStoparriveFirstStop`
Stops	`stops`	`object`	List of objects of stops along the route. For each stop, exactly one of addressId and singleUseLocation are required. Depending on the settings on your route, either a scheduledArrivalTime or scheduledDepartureTime must be specified for the first job. See further information
Vehicle Id	`vehicleId`	`string`	Select a value from the drop down menu.