Add Or Update Records with Grist API on Webhook Event Received (Instant) from Xero Accounting API

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

Trigger workflow on

Webhook Event Received (Instant) from the Xero Accounting API

Next, do this

Add Or Update Records with the Grist 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 Grist 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 Add Or Update Records action
1. Connect your Grist account
2. Configure Document ID
3. Select a Table ID
4. Optional- Configure Do Not Parse
5. Optional- Select a On Many
6. Optional- Configure No Add
7. Optional- Configure No Update
8. Configure Data Records
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.2

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 crypto from "crypto";
import xeroAccountingApi from "../../xero_accounting_api.app.mjs";

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.2",
  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#

Add Or Update Records on Grist

Description:Add records in a specified table or updates existing matching records. [See the documentation](https://support.getgrist.com/api/#tag/records/operation/replaceRecords)

Version:0.0.2

Key:grist-add-update-records

View on GitHub

Grist Overview#

Grist API on Pipedream enables you to automate data management tasks in your Grist documents. This might mean syncing data across different platforms, triggering notifications based on data changes, or processing data through custom logic. With Pipedream, you can use the Grist API to build workflows that react to events in real-time, connect to hundreds of other services, manipulate data in sophisticated ways, and create custom endpoints to integrate with your Grist data.

Action Code#

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

export default {
  key: "grist-add-update-records",
  name: "Add Or Update Records",
  description: "Add records in a specified table or updates existing matching records. [See the documentation](https://support.getgrist.com/api/#tag/records/operation/replaceRecords)",
  version: "0.0.2",
  type: "action",
  props: {
    app,
    docId: {
      propDefinition: [
        app,
        "docId",
      ],
    },
    tableId: {
      propDefinition: [
        app,
        "tableId",
        ({ docId }) => ({
          docId,
        }),
      ],
    },
    noParse: {
      propDefinition: [
        app,
        "noParse",
      ],
    },
    onMany: {
      type: "string",
      label: "On Many",
      description: "Which records to update if multiple records are found to match.",
      optional: true,
      options: [
        {
          value: "first",
          label: "The first matching record (default)",
        },
        {
          value: "none",
          label: "Do not update anything",
        },
        {
          value: "all",
          label: "Update all matches",
        },
      ],
    },
    noAdd: {
      type: "boolean",
      label: "No Add",
      description: "Set to true to prohibit adding records.",
      optional: true,
    },
    noUpdate: {
      type: "boolean",
      label: "No Update",
      description: "Set to true to prohibit updating records.",
      optional: true,
    },
    records: {
      description: app.propDefinitions.records.description + " Instead of an id, a `require` object is provided, with the same structure as `fields`. If no query parameter options are set, then the operation is as follows. First, we check if a record exists matching the values specified for columns in `require`. If so, we update it by setting the values specified for columns in fields. If not, we create a new record with a combination of the values in `require` and `fields`, with `fields` taking priority if the same column is specified in both. The query parameters allow for variations on this behavior. Eg. `[ { \"require\": { \"pet\": \"cat\" }, \"fields\": { \"popularity\": 67 } } ]`",
      propDefinition: [
        app,
        "records",
      ],
    },
  },
  methods: {
    addUpdateRecords({
      docId, tableId, ...args
    } = {}) {
      return this.app.put({
        path: `/docs/${docId}/tables/${tableId}/records`,
        ...args,
      });
    },
  },
  async run({ $ }) {
    const {
      addUpdateRecords,
      docId,
      tableId,
      noParse: noparse,
      onMany: onmany,
      noAdd: noadd,
      noUpdate: noupdate,
      records,
    } = this;

    await addUpdateRecords({
      $,
      docId,
      tableId,
      params: {
        noparse,
        onmany,
        noadd,
        noupdate,
      },
      data: {
        records: utils.parseArray(records),
      },
    });

    $.export("$summary", "Successfully ran this action");

    return {
      success: true,
    };
  },
};

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
Grist	`app`	`app`	This component uses the Grist app.
Document ID	`docId`	`string`	The ID of the Grist document to operate on. You can find this in the Settings menu of the document.
Table ID	`tableId`	`string`	Select a value from the drop down menu.
Do Not Parse	`noParse`	`boolean`	Set to `true` to prohibit parsing strings according to the column type.
On Many	`onMany`	`string`	Select a value from the drop down menu:`{ "value": "first", "label": "The first matching record (default)" }{ "value": "none", "label": "Do not update anything" }{ "value": "all", "label": "Update all matches" }`
No Add	`noAdd`	`boolean`	Set to true to prohibit adding records.
No Update	`noUpdate`	`boolean`	Set to true to prohibit updating records.
Data Records	`records`	`string[]`	The data for the records to append or update. Each record should be a JSON-formatted string, mapping column names to cell values. Eg. `[ { "fields": { "pet": "cat", "popularity": 67 } } ]`. Instead of an id, a `require` object is provided, with the same structure as `fields`. If no query parameter options are set, then the operation is as follows. First, we check if a record exists matching the values specified for columns in `require`. If so, we update it by setting the values specified for columns in fields. If not, we create a new record with a combination of the values in `require` and `fields`, with `fields` taking priority if the same column is specified in both. The query parameters allow for variations on this behavior. Eg. `[ { "require": { "pet": "cat" }, "fields": { "popularity": 67 } } ]`

Action Authentication#

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

To retrieve your API key,

Navigate to your Girst account and sign in
Go to “Profile Settings” > “API”

Add Or Update Records with Grist API on Webhook Event Received (Instant) from Xero Accounting API

Pipedream makes it easy to connect APIs for Grist, Xero Accounting 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