Upload File with Xero Accounting API on New Webhook Event (Instant) from Basecamp API

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

Trigger workflow on

New Webhook Event (Instant) from the Basecamp API

Next, do this

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

Select this integration
Configure the New Webhook Event (Instant) trigger
1. Connect your Basecamp account
2. Select a Account ID
3. Select a Project ID
4. Select one or more Event Types
Configure the Upload File action
1. Connect your Xero Accounting account
2. Select a Tenant ID
3. Configure File Path or URL
4. Select a Document Type
5. Configure Document ID
6. Optional- Configure syncDir
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 Webhook Event (Instant) on Basecamp

Description:Emit events of one or more selected types. [See the documentation](https://github.com/basecamp/bc3-api/blob/master/sections/webhooks.md#webhooks)

Version:0.0.8

Key:basecamp-new-event-by-webhook-type

View on GitHub

Basecamp Overview#

The Basecamp API enables the automation of project management tasks, facilitating seamless interaction with Basecamp's project management tools. Through Pipedream, you can leverage the API to create custom workflows that trigger actions within Basecamp, sync data across various platforms, and enhance team collaboration with automated notifications and task management.

Trigger Code#

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

export default {
  ...common,
  key: "basecamp-new-event-by-webhook-type",
  name: "New Webhook Event (Instant)",
  description: "Emit events of one or more selected types. [See the documentation](https://github.com/basecamp/bc3-api/blob/master/sections/webhooks.md#webhooks)",
  version: "0.0.8",
  dedupe: "unique",
  type: "source",
  props: {
    ...common.props,
    webhookTypes: {
      type: "string[]",
      label: "Event Types",
      description: "Select the types of events to be emitted. [See the documentation](https://github.com/basecamp/bc3-api/blob/master/sections/webhooks.md#webhooks) for more information.",
      options: constants.WEBHOOK_TYPE_OPTS,
    },
  },
  methods: {
    ...common.methods,
    getWebhookTypes() {
      return this.webhookTypes;
    },
    filterEvent(event) {
      return event;
    },
  },
};

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
Basecamp	`app`	`app`	This component uses the Basecamp app.
Account ID	`accountId`	`string`	Select a value from the drop down menu.
Project ID	`projectId`	`string`	Select a value from the drop down menu.
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	`webhookTypes`	`string[]`	Select a value from the drop down menu:`CommentClient::Approval::ResponseClient::ForwardClient::ReplyCloudFileDocumentGoogleDocumentInbox::ForwardMessageQuestionQuestion::AnswerSchedule::EntryTodoTodolistUploadVault`

Trigger Authentication#

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

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

About Basecamp#

Project Management & Team Communication

Action#

Upload File on Xero Accounting

Description:Uploads a file to the specified document. [See the documentation](https://developer.xero.com/documentation/api/accounting/invoices#upload-attachment)

Version:1.0.2

Key:xero_accounting_api-upload-file

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.

Action Code#

import { getFileStreamAndMetadata } from "@pipedream/platform";
import xeroAccountingApi from "../../xero_accounting_api.app.mjs";

export default {
  key: "xero_accounting_api-upload-file",
  name: "Upload File",
  description: "Uploads a file to the specified document. [See the documentation](https://developer.xero.com/documentation/api/accounting/invoices#upload-attachment)",
  version: "1.0.2",
  type: "action",
  props: {
    xeroAccountingApi,
    tenantId: {
      propDefinition: [
        xeroAccountingApi,
        "tenantId",
      ],
    },
    filePathOrUrl: {
      type: "string",
      label: "File Path or URL",
      description: "The file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`)",
    },
    documentType: {
      label: "Document Type",
      type: "string",
      description: "Document type of where the attachment will be sent to. This is used in as part of the Xero Account API endpoint where the request is sent against.",
      options: [
        "Accounts",
        "BankTransactions",
        "Contacts",
        "CreditNotes",
        "Invoices",
        "ManualJournals",
        "PurchaseOrders",
        "Receipts",
        "RepeatingInvoices",
      ],
    },
    documentId: {
      label: "Document ID",
      type: "string",
      description: "Xero identifier of the document where the attachment will be sent to.",
    },
    syncDir: {
      type: "dir",
      accessMode: "read",
      sync: true,
      optional: true,
    },
  },
  methods: {
    streamToBuffer(stream) {
      return new Promise((resolve, reject) => {
        const chunks = [];
        stream.on("data", (chunk) => chunks.push(chunk));
        stream.on("end", () => resolve(Buffer.concat(chunks)));
        stream.on("error", reject);
      });
    },
  },
  async run({ $ }) {
    const {
      stream, metadata,
    } = await getFileStreamAndMetadata(this.filePathOrUrl);
    const fileBinary = await this.streamToBuffer(stream);

    const response = await this.xeroAccountingApi.uploadFile({
      $,
      tenantId: this.tenantId,
      documentType: this.documentType,
      documentId: this.documentId,
      fileName: metadata.name,
      headers: {
        "Content-Type": metadata.contentType,
        "Content-Length": metadata.size,
        "Accept": "application/json",
      },
      data: Buffer.from(fileBinary, "binary"),
    });

    $.export("$summary", `Successfully uploaded file to ${this.documentType} with ID: ${this.documentId}`);
    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
Xero Accounting	`xeroAccountingApi`	`app`	This component uses the Xero Accounting app.
Tenant ID	`tenantId`	`string`	Select a value from the drop down menu.
File Path or URL	`filePathOrUrl`	`string`	The file to upload. Provide either a file URL or a path to a file in the `/tmp` directory (for example, `/tmp/myFile.txt`)
Document Type	`documentType`	`string`	Select a value from the drop down menu:`AccountsBankTransactionsContactsCreditNotesInvoicesManualJournalsPurchaseOrdersReceiptsRepeatingInvoices`
Document ID	`documentId`	`string`	Xero identifier of the document where the attachment will be sent to.
syncDir	`syncDir`	`dir`

Action 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

Upload File with Xero Accounting API on New Webhook Event (Instant) from Basecamp API

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

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

Developers ♥ Pipedream

1-24of2,800+apps by most popular

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