Create Attachment with Salesforce API on New Event (Instant) from ShipStation API

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

Trigger workflow on

New Event (Instant) from the ShipStation API

Next, do this

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

Select this integration
Configure the New Event (Instant) trigger
1. Connect your ShipStation account
2. Select a Event Type
3. Optional- Select a Store
Configure the Create Attachment action
1. Connect your Salesforce account
2. Configure File Name
3. Configure File Path or Content
4. Configure Content Type
5. Configure Parent ID
6. Optional- Configure Description
7. Optional- Configure Private
8. Optional- Select a Owner ID
9. Configure docsInfo
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 Event (Instant) on ShipStation

Description:Emit new event for each new webhook event received. [See docs here](https://www.shipstation.com/docs/api/webhooks/subscribe/)

Version:0.0.1

Key:shipstation-new-event

View on GitHub

ShipStation Overview#

The ShipStation API allows for streamlined management of shipping operations for e-commerce. With it, you can automate order processing, label creation, and tracking updates. Pipedream excels as a platform for integrating ShipStation with other services to create custom workflows.

Trigger Code#

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

export default {
  ...base,
  key: "shipstation-new-event",
  name: "New Event (Instant)",
  description: "Emit new event for each new webhook event received. [See docs here](https://www.shipstation.com/docs/api/webhooks/subscribe/)",
  version: "0.0.1",
  type: "source",
  methods: {
    ...base.methods,
    async emitEvent(event) {
      const { body } = event;

      const resource = await this.shipstation.getResourceByUrl({
        url: body.resource_url,
      });

      const ts = new Date();

      this.$emit(resource, {
        id: ts,
        summary: `New event ${ts.getTime()} received`,
        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
ShipStation	`shipstation`	`app`	This component uses the ShipStation 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 Type	`eventType`	`string`	Select a value from the drop down menu:`{ "label": "On New Orders", "value": "ORDER_NOTIFY" }{ "label": "On New Items", "value": "ITEM_ORDER_NOTIFY" }{ "label": "On Orders Shipped", "value": "SHIP_NOTIFY" }{ "label": "On Items Shipped", "value": "ITEM_SHIP_NOTIFY" }`
Store	`storeId`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

The ShipStation API uses Basic HTTP authentication. Use your ShipStation API Key as the username and API Secret as the password. You can find your API Key under Settings.

About ShipStation#

Import, manage and ship your orders with ShipStation

Action#

Create Attachment on Salesforce

Description:Creates an Attachment on a parent object. [See the documentation](https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attachment.htm)

Version:0.4.0

Key:salesforce_rest_api-create-attachment

View on GitHub

Salesforce Overview#

The Salesforce (REST API) provides a powerful platform for creating and managing customer relationships with a wide array of features like data manipulation, querying, and complex automation. With Pipedream's serverless execution, you can create workflows that automate your sales processes, sync data with other platforms, enhance customer engagement, and trigger actions based on specific events. Dive into Salesforce data, streamline lead management, track customer interactions, and push or pull data to or from Salesforce seamlessly.

Action Code#

import common, { getProps } from "../common/base-create-update.mjs";
import attachment from "../../common/sobjects/attachment.mjs";
import fs from "fs";

const docsLink = "https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_attachment.htm";

/* eslint-disable no-unused-vars */
const {
  useAdvancedProps, ...props
} = getProps({
  objType: attachment,
  docsLink,
});
/* eslint-enable no-unused-vars */

export default {
  ...common,
  key: "salesforce_rest_api-create-attachment",
  name: "Create Attachment",
  description: `Creates an Attachment on a parent object. [See the documentation](${docsLink})`,
  version: "0.4.0",
  type: "action",
  props,
  async run({ $ }) {
    /* eslint-disable no-unused-vars */
    const {
      salesforce,
      getAdvancedProps,
      getAdditionalFields,
      formatDateTimeProps,
      docsInfo,
      filePathOrContent,
      ...data
    } = this;
    /* eslint-enable no-unused-vars */

    const body =  filePathOrContent.includes("tmp/")
      ? (await fs.promises.readFile(filePathOrContent)).toString("base64")
      : filePathOrContent;

    const response = await salesforce.createRecord("Attachment", {
      $,
      data: {
        Body: body,
        ...data,
      },
    });
    $.export("$summary", `Successfully created attachment "${this.Name}"`);
    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
Salesforce	`salesforce`	`app`	This component uses the Salesforce app.
File Name	`Name`	`string`	Name of the attached file. Max 255 characters.
File Path or Content	`filePathOrContent`	`string`	The path to a file in the `tmp` folder (see the documentation). Alternatively, you can provide the base64-encoded file data.
Content Type	`ContentType`	`string`	The content type (MIME type) of the attachment. For example, `image/png`.
Parent ID	`ParentId`	`string`	ID of the parent object of the attachment. See the documentation for supported objects.
Description	`Description`	`string`	Description of the attachment. Max 500 characters.
Private	`IsPrivate`	`boolean`	Whether this record is viewable only by the owner and administrators (true) or viewable by all otherwise-allowed users (false).
Owner ID	`OwnerId`	`string`	Select a value from the drop down menu.

Action Authentication#

Salesforce uses OAuth authentication. When you connect your Salesforce account, Pipedream will open a popup window where you can sign into Salesforce and grant Pipedream permission to connect to your account. Pipedream securely stores and automatically refreshes the OAuth tokens so you can easily authenticate any Salesforce API.

Pipedream requests the following authorization scopes when you connect your account:

About Salesforce#

Web services API for interacting with Salesforce

More Ways to Connect Salesforce + ShipStation#

Other Popular Integrations#

Create Order with ShipStation API on New Updated Field on Record (Instant, of Selectable Type) from Salesforce API

Salesforce + ShipStation

Create Attachment with Salesforce API on New Event (Instant) from ShipStation API

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

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

1-24of2,400+apps by most popular

1
-
24
of
2,400+
apps by most popular