Create Order with Starshipit API on Webhook Event Received (Instant) from Xero Accounting API

Pipedream makes it easy to connect APIs for Starshipit, Xero Accounting and 2,700+ other apps remarkably fast.

Trigger workflow on

Webhook Event Received (Instant) from the Xero Accounting API

Next, do this

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

Select this integration
Configure the Webhook Event Received (Instant) trigger
1. Connect your Xero Accounting account
2. Optional- Configure Webhook Key
Configure the Create Order action
1. Connect your Starshipit account
2. Configure Order Number
3. Select a Destination
4. Configure Number of 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#

Webhook Event Received (Instant) on Xero Accounting

Description:Emit new event for each incoming webhook notification. To create a Xero Webhook, please follow [the instructions here](https://developer.xero.com/documentation/guides/webhooks/creating-webhooks/).

Version:0.0.1

Key:xero_accounting_api-webhook-event-received

View on GitHub

Xero Accounting Overview#

The Xero Accounting API offers a powerful gateway to access and manipulate financial data within Xero. Leveraging Pipedream's capabilities, developers can build custom workflows that streamline accounting processes, sync financial data with external systems, and trigger actions based on financial events. This API allows for the automation of tasks such as invoicing, bank reconciliation, bill payments, and reporting, which can lead to significant time savings and enhanced data accuracy.

Trigger Code#

import xeroAccountingApi from "../../xero_accounting_api.app.mjs";
import crypto from "crypto";

export default {
  key: "xero_accounting_api-webhook-event-received",
  name: "Webhook Event Received (Instant)",
  description: "Emit new event for each incoming webhook notification. To create a Xero Webhook, please follow [the instructions here](https://developer.xero.com/documentation/guides/webhooks/creating-webhooks/).",
  version: "0.0.1",
  type: "source",
  props: {
    xeroAccountingApi,
    http: {
      type: "$.interface.http",
      customResponse: true,
    },
    webhookKey: {
      type: "string",
      label: "Webhook Key",
      description: "You can leave this blank when creating this source. After creating a webhook in Xero, please update this prop with the value provided.",
      secret: true,
      optional: true,
    },
  },
  hooks: {
    async deploy() {
      console.log("You can now copy the generated URL endpoint from this source and go to Xero and create a webhook.");
      console.log("After saving, copy the `Webhooks key` and update the prop.");
      console.log("Then click on `Send 'Intent to receive'` to start the signature verification process.");
      console.log("We will receive three requests for signature verification, and after that the `Status` should be OK.");
    },
  },
  methods: {
    httpRespond(status) {
      this.http.respond({
        status,
      });
    },
    validateEvent(event) {
      if (!this.webhookKey) {
        console.log("No webhook key supplied. Please update the prop with the value supplied by Xero.");
        return false;
      }

      console.log("Verifying signature...");
      const sig = crypto.createHmac("sha256", this.webhookKey)
        .update(event.bodyRaw)
        .digest("base64");
      return sig === event.headers["x-xero-signature"];
    },
    emitEvents(events) {
      events.forEach((event) => {
        const {
          resourceId: id,
          eventDateUtc: ts,
          eventType,
          eventCategory,
        } = event;

        this.$emit(event, {
          id,
          summary: `${eventCategory} ${eventType} event received`,
          ts: new Date(ts),
        });
      });
    },
  },
  async run(event) {
    if (!this.validateEvent(event)) {
      console.log("Invalid signature. Ignoring event...");
      this.httpRespond(401);
    }

    this.httpRespond(200);
    this.emitEvents(event.body?.events);
  },
};

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
Xero Accounting	`xeroAccountingApi`	`app`	This component uses the Xero Accounting 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.
Webhook Key	`webhookKey`	`string`	You can leave this blank when creating this source. After creating a webhook in Xero, please update this prop with the value provided.

Trigger Authentication#

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

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

offline_accessopenidprofileemailaccounting.transactionsaccounting.transactions.readaccounting.reports.readaccounting.settingsaccounting.settings.readaccounting.contactsaccounting.attachmentsaccounting.journals.read

About Xero Accounting#

Accounting Software

Action#

Create Order on Starshipit

Description:Create an outbound order in Starshipit. [See the documentation](https://api-docs.starshipit.com/#b90251d2-1d1c-47b1-ac07-eeeb21cade7b)

Version:0.0.1

Key:starshipit-create-order

View on GitHub

Starshipit Overview#

The Starshipit API is a tool for optimizing and automating shipping and fulfillment processes. By integrating it with Pipedream, you can create powerful serverless workflows that connect Starshipit with other apps and services to streamline e-commerce operations, reduce manual entry, and improve customer experiences. From automating order dispatch to synchronizing tracking information across platforms, the possibilities are vast.

Action Code#

import starshipit from "../../starshipit.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "starshipit-create-order",
  name: "Create Order",
  description: "Create an outbound order in Starshipit. [See the documentation](https://api-docs.starshipit.com/#b90251d2-1d1c-47b1-ac07-eeeb21cade7b)",
  version: "0.0.1",
  type: "action",
  props: {
    starshipit,
    orderNumber: {
      type: "string",
      label: "Order Number",
      description: "The identifier of the order pulled from source e-Commerce platform (max length: 50)",
    },
    destination: {
      propDefinition: [
        starshipit,
        "contactId",
      ],
    },
    numItems: {
      type: "integer",
      label: "Number of Items",
      description: "Number of items in the order",
      reloadProps: true,
    },
  },
  additionalProps() {
    const props = {};
    for (let i = 1; i <= this.numItems; i++) {
      props[`item_${i}_description`] = {
        type: "string",
        label: `Item ${i} Description`,
        description: "Product name or description",
        optional: true,
      };
      props[`item_${i}_quantity`] = {
        type: "string",
        label: `Item ${i} Quantity`,
        description: "The number of product ordered",
        optional: true,
      };
      props[`item_${i}_weight`] = {
        type: "string",
        label: `Item ${i} Weight`,
        description: "Unit weight of the product in kilograms (kg)",
        optional: true,
      };
      props[`item_${i}_value`] = {
        type: "string",
        label: `Item ${i} Value`,
        description: "Unit price of the product",
        optional: true,
      };
    }
    return props;
  },
  methods: {
    async getOrderContact(destinationId) {
      const contacts = await this.starshipit.paginate({
        resourceFn: this.starshipit.listContacts,
        resourceName: "addresses",
      });
      return contacts.find(({ id }) => id === destinationId);
    },
    parseFloat(i, type) {
      return utils.parseFloatProp(this, "item", i, type);
    },
  },
  async run({ $ }) {
    const items = [];
    for (let i = 1; i <= this.numItems; i++) {
      items.push({
        description: this[`item_${i}_description`],
        quantity: this.parseFloat(i, "quantity"),
        weight: this.parseFloat(i, "weight"),
        value: this.parseFloat(i, "value"),
      });
    }
    const destination = await this.getOrderContact(this.destination);

    const response = await this.starshipit.createOrder({
      data: {
        order: {
          order_number: this.orderNumber,
          destination,
          items,
        },
      },
      $,
    });
    if (response?.success === false) {
      throw new Error(`${response.errors[0].message}: ${response.errors[0].details}`);
    }
    if (response?.order?.order_id) {
      $.export("$summary", `Successfully created order with ID: ${response.order.order_id}`);
    }
    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
Starshipit	`starshipit`	`app`	This component uses the Starshipit app.
Order Number	`orderNumber`	`string`	The identifier of the order pulled from source e-Commerce platform (max length: 50)
Destination	`destination`	`string`	Select a value from the drop down menu.
Number of Items	`numItems`	`integer`	Number of items in the order

Action Authentication#

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

To retrieve your API keys,