EventBridge - Send Event to Event Bus with AWS API on Webhook Event Received (Instant) from Xero Accounting API

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

Trigger workflow on

Webhook Event Received (Instant) from the Xero Accounting API

Next, do this

EventBridge - Send Event to Event Bus with the AWS 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 AWS 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 EventBridge - Send Event to Event Bus action
1. Connect your AWS account
2. Select a AWS Region
3. Select a Event Bus Name
4. Configure Event data
5. Optional- Configure Detail Type
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#

EventBridge - Send Event to Event Bus on AWS

Description:Sends an event to an EventBridge event bus. [See documentation](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/eventbridge/command/PutEventsCommand/)

Version:0.4.3

Key:aws-eventbridge-send-event

View on GitHub

AWS Overview#

The AWS API unlocks endless possibilities for automation with Pipedream. With this powerful combo, you can manage your AWS services and resources, automate deployment workflows, process data, and react to events across your AWS infrastructure. Pipedream offers a serverless platform for creating workflows triggered by various events that can execute AWS SDK functions, making it an efficient tool to integrate, automate, and orchestrate tasks across AWS services and other apps.

Action Code#

import aws from "../../aws.app.mjs";
import common from "../../common/common-eventbridge.mjs";

export default {
  ...common,
  key: "aws-eventbridge-send-event",
  name: "EventBridge - Send Event to Event Bus",
  description: "Sends an event to an EventBridge event bus. [See documentation](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/eventbridge/command/PutEventsCommand/)",
  version: "0.4.3",
  type: "action",
  props: {
    aws: common.props.aws,
    region: common.props.region,
    eventBusName: common.props.eventBusName,
    eventData: {
      propDefinition: [
        aws,
        "eventData",
      ],
      optional: false,
    },
    detailType: {
      type: "string",
      label: "Detail Type",
      description: "Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail. Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that does not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.",
      optional: true,
    },
  },
  async run({ $ }) {
    const params = {
      Entries: [
        {
          Detail: JSON.stringify(this.eventData),
          DetailType: this.detailType || Object.keys(this.eventData).join(" "),
          EventBusName: this.eventBusName,
          Source: "pipedream",
        },
      ],
    };

    const response = await this.eventBridgeSendEvent(params);
    $.export("$summary", `Sent event data to ${this.eventBusName} bridge`);
    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
AWS	`aws`	`app`	This component uses the AWS app.
AWS Region	`region`	`string`	Select a value from the drop down menu.
Event Bus Name	`eventBusName`	`string`	Select a value from the drop down menu.
Event data	`eventData`	`object`	A JSON object that will be sent as an event
Detail Type	`detailType`	`string`	Free-form string, with a maximum of 128 characters, used to decide what fields to expect in the event detail. Detail, DetailType, and Source are required for EventBridge to successfully send an event to an event bus. If you include event entries in a request that does not include each of those properties, EventBridge fails that entry. If you submit a request in which none of the entries have each of these properties, EventBridge fails the entire request.

Action Authentication#

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

Follow the AWS Instructions for creating an IAM user with an associated access and secret key.

As a best practice, attach the minimum set of IAM permissions necessary to perform the specific task in Pipedream. If your workflow only needs to perform a single API call, you should create a user and associate an IAM group / policy with permission to do only that task. You can create as many linked AWS accounts in Pipedream as you'd like.

Enter your access and secret key below.

About AWS#

Amazon Web Services (AWS) offers reliable, scalable, and inexpensive cloud computing services.

More Ways to Connect AWS + Xero Accounting#

Other Popular Integrations#

Create Payment with Xero Accounting API on New Emails sent to SES Catch-all Domain from AWS API

AWS + Xero Accounting

EventBridge - Send Event to Event Bus with AWS API on Webhook Event Received (Instant) from Xero Accounting API

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