Create Shipment Quote with shipcloud API on New Events (Instant) from Twilio SendGrid API

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

Trigger workflow on

New Events (Instant) from the Twilio SendGrid API

Next, do this

Create Shipment Quote with the shipcloud 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 Twilio SendGrid trigger and shipcloud action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Events (Instant) trigger
1. Connect your Twilio SendGrid account
2. Select one or more Event Types
Configure the Create Shipment Quote action
1. Connect your shipcloud account
2. Select a Carrier
3. Select a Service
4. Select a Recipient Address
5. Select a Sender Address
6. Configure Package
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 Events (Instant) on Twilio SendGrid

Description:Emit new event when any of the specified SendGrid events is received

Version:0.0.5

Key:sendgrid-events

View on GitHub

Twilio SendGrid Overview#

The Twilio SendGrid API opens up a world of possibilities for email automation, enabling you to send emails efficiently and track their performance. With this API, you can programmatically create and send personalized email campaigns, manage contacts, and parse inbound emails for data extraction. When you harness the power of Pipedream, you can connect SendGrid to hundreds of other apps to automate workflows, such as triggering email notifications based on specific actions, syncing email stats with your analytics, or handling incoming emails to create tasks or tickets.

Trigger Code#

import common from "../common/http-based.mjs";
import deliveryEventTypes from "./delivery-event-types.mjs";
import engagementEventTypes from "./engagement-event-types.mjs";

export default {
  ...common,
  key: "sendgrid-events",
  name: "New Events (Instant)",
  description: "Emit new event when any of the specified SendGrid events is received",
  version: "0.0.5",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    eventTypes: {
      type: "string[]",
      label: "Event Types",
      description: "The type of events to listen to",
      options(context) {
        const { page } = context;
        if (page !== 0) {
          return {
            options: [],
          };
        }

        const options = [
          ...deliveryEventTypes,
          ...engagementEventTypes,
        ];
        return {
          options,
        };
      },
    },
  },
  methods: {
    ...common.methods,
    baseWebhookSettings() {
      // The list of events that a webhook can listen to. This method returns an
      // exhaustive list of all such flags disabled, and each event source can
      // then override the flags that are relevant to the event they handle.
      //
      // See the docs for more information:
      // https://sendgrid.com/docs/api-reference/
      const eventTypesData = [
        ...deliveryEventTypes,
        ...engagementEventTypes,
      ];
      return eventTypesData.reduce((accum, eventTypeData) => ({
        ...accum,
        [eventTypeData.value]: false,
      }), {});
    },
    webhookEventFlags() {
      return this.eventTypes.reduce((accum, eventType) => ({
        ...accum,
        [eventType]: true,
      }), {});
    },
    generateMeta(data) {
      const {
        event: eventType,
        sg_event_id: id,
        timestamp: ts,
      } = data;
      const summary = `New event: ${eventType}`;
      return {
        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
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Twilio SendGrid	`sendgrid`	`app`	This component uses the Twilio SendGrid 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.
Event Types	`eventTypes`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

About Twilio SendGrid#

Send marketing and transactional email through the Twilio SendGrid platform with the Email API, proprietary mail transfer agent, and infrastructure for scalable delivery.

Action#

Create Shipment Quote on shipcloud

Description:Create a shipment quote [See docs here](https://developers.shipcloud.io/reference/#creating-a-shipment-quote)

Version:0.0.1

Key:shipcloud-create-shipment-quote

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.

Action Code#

import shipcloud from "../../app/shipcloud.app.mjs";
import { defineAction } from "@pipedream/types";
export default defineAction({
    name: "Create Shipment Quote",
    description: "Create a shipment quote [See docs here](https://developers.shipcloud.io/reference/#creating-a-shipment-quote)",
    key: "shipcloud-create-shipment-quote",
    version: "0.0.1",
    type: "action",
    props: {
        shipcloud,
        carrier: {
            propDefinition: [
                shipcloud,
                "carrier",
            ],
        },
        service: {
            propDefinition: [
                shipcloud,
                "service",
            ],
        },
        toAddress: {
            propDefinition: [
                shipcloud,
                "address",
            ],
        },
        fromAddress: {
            propDefinition: [
                shipcloud,
                "address",
            ],
            label: "Sender Address",
        },
        package: {
            propDefinition: [
                shipcloud,
                "package",
            ],
        },
    },
    async run({ $ }) {
        const params = {
            $,
            data: {
                carrier: this.carrier,
                service: this.service,
                to: JSON.parse(this.toAddress),
                from: JSON.parse(this.fromAddress),
                package: this.package,
            },
        };
        const data = await this.shipcloud.createShipmentQuote(params);
        $.export("$summary", "Created shipment quote successfully");
        return data;
    },
});

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
shipcloud	`shipcloud`	`app`	This component uses the shipcloud app.
Carrier	`carrier`	`string`	Select a value from the drop down menu:`{ "label": "Angel DE", "value": "angel_de" }{ "label": "Cargo International", "value": "cargo_international" }{ "label": "DHL", "value": "dhl" }{ "label": "DHL Express", "value": "dhl_express" }{ "label": "DPAG", "value": "dpag" }{ "label": "DPD", "value": "dpd" }{ "label": "GLS", "value": "gls" }{ "label": "go", "value": "go" }{ "label": "hermes", "value": "hermes" }{ "label": "iloxx (MyDPD Business", "value": "iloxx" }{ "label": "PARCEL.ONE", "value": "parcel_one" }{ "label": "UPS", "value": "ups" }`
Service	`service`	`string`	Select a value from the drop down menu:`{ "label": "Standard", "value": "standard" }{ "label": "One Day", "value": "one_day" }{ "label": "One Day Early", "value": "one_day_early" }{ "label": "Returns", "value": "returns" }{ "label": "Asendia e-PAQ Standard Economy", "value": "asendia_epaq_standard_economy" }{ "label": "Asendia e-PAQ Standard Priority", "value": "asendia_epaq_standard_priority" }{ "label": "Cargo International Express", "value": "cargo_international_express" }{ "label": "DHL Europaket", "value": "dhl_europaket" }{ "label": "DHL Prio", "value": "dhl_prio" }{ "label": "DHL Warenpost", "value": "dhl_warenpost" }{ "label": "DPAG Warenpost", "value": "dpag_warenpost" }{ "label": "DPAG Warenpost Signature", "value": "dpag_warenpost_signature" }{ "label": "DPAG Warenpost Untracked", "value": "dpag_warenpost_untracked" }{ "label": "GLS Express 0800", "value": "gls_express_0800" }{ "label": "GLS Express 0900", "value": "gls_express_0900" }{ "label": "GLS Express 1000", "value": "gls_express_1000" }{ "label": "GLS Express 1200", "value": "gls_express_1200" }{ "label": "UPS Express 1200", "value": "ups_express_1200" }`
Recipient Address	`toAddress`	`string`	Select a value from the drop down menu.
Sender Address	`fromAddress`	`string`	Select a value from the drop down menu.
Package	`package`	`object`	Object describing the package. Required fields are `height`, `length`, `weight` and `width`. (See more info on the Shipcloud Docs)