Get User Submissions with Jotform API on New Shipment Status from shipcloud API

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

Trigger workflow on

New Shipment Status from the shipcloud API

Next, do this

Get User Submissions with the Jotform 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 shipcloud trigger and Jotform action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Shipment Status trigger
1. Connect your shipcloud account
2. Select one or more Event types
Configure the Get User Submissions action
1. Connect your Jotform account
2. Configure Max Items
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 Shipment Status on shipcloud

Description:Emit new event for shipment status changes [See docs here](https://developers.shipcloud.io/reference/#webhooks)

Version:0.0.1

Key:shipcloud-new-shipment-status

View on GitHub

shipcloud Overview#

Shipcloud is a shipping service provider API that streamlines parcel shipping processes for businesses of all sizes. With Shipcloud, you can access multiple carriers, compare shipping rates, create shipping labels, track parcels, and handle returns within a single interface. Utilizing this API on Pipedream enables automation of shipping workflows, leading to efficient and scalable logistics operations.

Trigger Code#

import shipcloud from "../../app/shipcloud.app.mjs";
import { defineSource, } from "@pipedream/types";
import { WEBHOOK_EVENT_TYPES } from "../../common/constants.mjs";
export default defineSource({
    name: "New Shipment Status",
    description: "Emit new event for shipment status changes [See docs here](https://developers.shipcloud.io/reference/#webhooks)",
    key: "shipcloud-new-shipment-status",
    version: "0.0.1",
    type: "source",
    props: {
        shipcloud,
        db: "$.service.db",
        http: {
            type: "$.interface.http",
            customResponse: true,
        },
        eventTypes: {
            label: "Event types",
            description: "The shipment update(s) that should trigger an event",
            type: "string[]",
            options: WEBHOOK_EVENT_TYPES,
        },
    },
    hooks: {
        async activate() {
            const data = {
                event_types: this.eventTypes,
                url: this.http.endpoint,
            };
            const { id } = await this.shipcloud.createHook(data);
            this.db.set("hookId", id);
        },
        async deactivate() {
            const id = this.db.get("hookId");
            await this.shipcloud.deleteHook({
                id,
            });
        },
    },
    async run(data) {
        this.http.respond({
            status: 200,
        });
        const { body } = data;
        let { id } = body;
        if (typeof id !== "string") {
            id = Date.now();
        }
        let summary = body.type;
        if (typeof summary !== "string") {
            summary = "Unknown event type";
        }
        const date = body.occured_at;
        const ts = typeof date === "string"
            ? new Date(date).valueOf()
            : Date.now();
        this.$emit(body, {
            id,
            summary,
            ts,
        });
    },
});

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
shipcloud	`shipcloud`	`app`	This component uses the shipcloud app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
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.
Event types	`eventTypes`	`string[]`	Select a value from the drop down menu:`shipment.shipment.status.shipment.status.deletedshipment.tracking.*shipment.tracking.awaits_pickup_by_receivershipment.tracking.canceledshipment.tracking.delayedshipment.tracking.deliveredshipment.tracking.destroyedshipment.tracking.exceptionshipment.tracking.label_createdshipment.tracking.not_deliveredshipment.tracking.notificationshipment.tracking.out_for_deliveryshipment.tracking.picked_upshipment.tracking.transitshipment.tracking.unknown`

Trigger Authentication#

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

Go here to retrieve your API key: https://app.shipcloud.io/en/users/api_key

About shipcloud#

Shipcloud is the shipping service provider and represents a new generation in package shipping. A cloud-based service, it enables small and medium-sized online vendors to work easily and efficiently with all major shipping providers.

Action#

Get User Submissions on Jotform

Description:Gets a list of all submissions for all forms on the account [See the docs here](https://api.jotform.com/docs/#user-submissions)

Version:0.1.3

Key:jotform-get-user-submissions

View on GitHub

Jotform Overview#

Jotform’s API is a powerhouse for automating form and survey data management. With Pipedream, harness this API to trigger workflows from new form submissions, manipulate and analyze your form data, and sync it across various platforms. Think streamlined data entry to CRMs, instant notifications for new leads or feedback, and timely data backups to cloud storage.

Action Code#

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

export default {
  ...common,
  key: "jotform-get-user-submissions",
  name: "Get User Submissions",
  description: "Gets a list of all submissions for all forms on the account [See the docs here](https://api.jotform.com/docs/#user-submissions)",
  version: "0.1.3",
  type: "action",
  props: {
    ...common.props,
    max: {
      propDefinition: [
        common.props.jotform,
        "max",
      ],
    },
  },
  async additionalProps() {
    const props = {};
    if (this.encrypted) {
      props.privateKey = common.props.jotform.propDefinitions.privateKey;
    }
    return props;
  },
  async run({ $ }) {
    const params = {
      $,
      max: this.max,
    };
    const submissions = await this.paginate(this.jotform.getUserSubmissions.bind(this), params);
    const results = [];
    for await (const submission of submissions) {
      results.push(submission);
    }
    $.export("$summary", `Successfully retrieved ${results.length} form submission${results.length === 1
      ? "s"
      : ""}`);
    return results;
  },
};

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
Jotform	`jotform`	`app`	This component uses the Jotform app.
Max Items	`max`	`integer`	Maximum number of items to return

Try it

Create Shipment with shipcloud API on New Submission (Instant) from Jotform API

Jotform + shipcloud

Try it

Get Shipment Info with shipcloud API on New Submission (Instant) from Jotform API

Jotform + shipcloud

Try it

Get Form Submissions with Jotform API on New Shipment Status from shipcloud API

shipcloud + Jotform

Try it

Get Monthly User Usage with Jotform API on New Shipment Status from shipcloud API

shipcloud + Jotform

Try it

Popular Triggers#

New Shipment Status from the shipcloud API

Emit new event for shipment status changes See docs here

Try it

New Submission (Instant) from the Jotform API

Emit new event when a form is submitted

Try it

Popular Actions#

Create Shipment with the shipcloud API

Create a shipment See docs here

Try it

Create Shipment Quote with the shipcloud API

Create a shipment quote See docs here

Try it

Get Shipment Info with the shipcloud API

Retrieve details for a shipment See docs here

Try it

Get Form Submissions with the Jotform API

Gets a list of form responses See the docs here

Try it

Get Monthly User Usage with the Jotform API

Gets number of form submissions received this month. Also, get number of SSL form submissions, payment form submissions and upload space used by user See the docs here

Try it