Create Customer with Pennylane API on New Records Returned by CloudWatch Logs Insights Query from AWS API

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

Trigger workflow on

New Records Returned by CloudWatch Logs Insights Query from the AWS API

Next, do this

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

Select this integration
Configure the New Records Returned by CloudWatch Logs Insights Query trigger
1. Connect your AWS account
2. Select a AWS Region
3. Select one or more CloudWatch Log Groups
4. Configure Logs Insights Query
5. Optional- Configure Emit query results as a single event
6. Configure Polling schedule
Configure the Create Customer action
1. Connect your Pennylane account
2. Select a Customer Type
3. Configure First Name
4. Configure Last Name
5. Optional- Select a Gender
6. Configure Name
7. Optional- Configure Reg No
8. Configure Address
9. Configure Postal Code
10. Configure City
11. Configure Country
12. Optional- Configure Recipient
13. Optional- Configure VAT Number
14. Optional- Configure Source Id
15. Optional- Configure Emails
16. Optional- Configure Billing IBAN
17. Optional- Configure Delivery Address
18. Optional- Configure Delivery Postal Code
19. Optional- Configure Delivery City
20. Optional- Configure Delivery Country
21. Optional- Select a Payment Conditions
22. Optional- Configure Phone
23. Optional- Configure Reference
24. Optional- Configure Notes
25. Optional- Configure Mandate
26. Optional- Configure Plan Item
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 Records Returned by CloudWatch Logs Insights Query on AWS

Description:Executes a CloudWatch Logs Insights query on a schedule, and emits the records as invidual events (default) or in batch

Version:0.2.2

Key:aws-new-records-returned-by-cloudwatch-logs-insights-query

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.

Trigger Code#

import common from "../../common/common-cloudwatch-logs.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  ...common,
  key: "aws-new-records-returned-by-cloudwatch-logs-insights-query",
  name: "New Records Returned by CloudWatch Logs Insights Query",
  // eslint-disable-next-line pipedream/source-description
  description: "Executes a CloudWatch Logs Insights query on a schedule, and emits the records as invidual events (default) or in batch",
  version: "0.2.2",
  type: "source",
  props: {
    aws: common.props.aws,
    region: common.props.region,
    db: "$.service.db",
    // eslint-disable-next-line pipedream/props-label
    logGroupNames: {
      ...common.props.logGroupName,
      type: "string[]",
      description: "The log groups you'd like to query",
    },
    queryString: {
      label: "Logs Insights Query",
      description: "The query you'd like to run. See [this AWS doc](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/CWL_QuerySyntax.html) for help with query syntax",
      type: "string",
    },
    emitResultsInBatch: {
      type: "boolean",
      label: "Emit query results as a single event",
      description: "If `true`, all events are emitted as an array, within a single Pipedream event. If `false`, each row of results is emitted as its own event. Defaults to `true`",
      optional: true,
      default: true,
    },
    timer: {
      label: "Polling schedule",
      description: "How often you want to query CloudWatch Logs Insights for results",
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
  },
  async run() {
    const now = +new Date();
    const startTime = this.db.get("startTime") || now - 1000 * 60 * 60;

    // First, start the query
    const params = {
      queryString: this.queryString,
      startTime,
      endTime: now,
      logGroupNames: this.logGroupNames,
    };

    const { queryId } = await this.startQuery(params);

    // Then poll for its status, emitting each record as its own event when completed
    async function sleep(ms) {
      return new Promise((r) => setTimeout(r, ms));
    }

    let result, res;
    do {
      await sleep(1000);
      res = await this.getQueryResults({
        queryId,
      });
      result = res.status;
    } while (result === "Running" || result === "Scheduled");

    if (result !== "Complete") {
      throw new Error(`Query ${queryId} failed with status ${result}`);
    }

    console.log(JSON.stringify(res, null, 2));
    const { results } = res;

    if (!results || !results.length) {
      console.log("No results, exiting");
      this.db.set("startTime", now);
      return;
    }

    if (this.emitResultsInBatch === true) {
      this.$emit(results, {
        summary: JSON.stringify(results),
      });
    } else {
      for (const item of results) {
        this.$emit(item, {
          summary: JSON.stringify(item),
        });
      }
    }

    // The next time this source runs, query for data starting now
    this.db.set("startTime", now);
  },
};

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
AWS	`aws`	`app`	This component uses the AWS app.
AWS Region	`region`	`string`	Select a value from the drop down menu.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
CloudWatch Log Groups	`logGroupNames`	`string[]`	Select a value from the drop down menu.
Logs Insights Query	`queryString`	`string`	The query you'd like to run. See this AWS doc for help with query syntax
Emit query results as a single event	`emitResultsInBatch`	`boolean`	If `true`, all events are emitted as an array, within a single Pipedream event. If `false`, each row of results is emitted as its own event. Defaults to `true`
Polling schedule	`timer`	`$.interface.timer`	How often you want to query CloudWatch Logs Insights for results

Trigger 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.

Action#

Create Customer on Pennylane

Description:Creates a new customer in Pennylane. [See the documentation](https://pennylane.readme.io/reference/customers-post-1)

Version:0.0.1

Key:pennylane-create-customer

View on GitHub

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import {
  CUSTOMER_GENDER_OPTIONS,
  CUSTOMER_TYPE_OPTIONS, PAYMENT_CONDITIONS_OPTIONS,
} from "../../common/constants.mjs";
import { parseObject } from "../../common/utils.mjs";
import pennylane from "../../pennylane.app.mjs";

export default {
  key: "pennylane-create-customer",
  name: "Create Customer",
  description: "Creates a new customer in Pennylane. [See the documentation](https://pennylane.readme.io/reference/customers-post-1)",
  version: "0.0.1",
  type: "action",
  props: {
    pennylane,
    customerType: {
      type: "string",
      label: "Customer Type",
      description: "The type of the customer you want to create.",
      options: CUSTOMER_TYPE_OPTIONS,
      reloadProps: true,
    },
    firstName: {
      type: "string",
      label: "First Name",
      description: "Customer first name.",
      hidden: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "Customer last name.",
      hidden: true,
    },
    gender: {
      type: "string",
      label: "Gender",
      description: "Customer Gender",
      options: CUSTOMER_GENDER_OPTIONS,
      hidden: true,
      optional: true,
    },
    name: {
      type: "string",
      label: "Name",
      description: "The name of the company.",
      hidden: true,
    },
    regNo: {
      type: "string",
      label: "Reg No",
      description: "Customer registration number (SIREN).",
      hidden: true,
      optional: true,
    },
    address: {
      type: "string",
      label: "Address",
      description: "Customer address (billing address).",
    },
    postalCode: {
      type: "string",
      label: "Postal Code",
      description: "Postal code (billing address).",
    },
    city: {
      type: "string",
      label: "City",
      description: "City (billing address).",
    },
    country: {
      type: "string",
      label: "Country",
      description: "Any ISO 3166 Alpha-2 country code (billing address).",
    },
    recipient: {
      type: "string",
      label: "Recipient",
      description: "Recipient displayed in the invoice.",
      hidden: true,
      optional: true,
    },
    vatNumber: {
      type: "string",
      label: "VAT Number",
      description: "Customer's VAT number.",
      hidden: true,
      optional: true,
    },
    sourceId: {
      type: "string",
      label: "Source Id",
      description: "You can use your own id when creating the customer. If not provided, Pennylane will pick one for you. Id must be unique.",
      optional: true,
    },
    emails: {
      type: "string[]",
      label: "Emails",
      description: "A list of customer emails.",
      optional: true,
    },
    billingIban: {
      type: "string",
      label: "Billing IBAN",
      description: "The billing IBAN of the customer. This is the iban on which you wish to receive payment from this customer.",
      optional: true,
    },
    deliveryAddress: {
      type: "string",
      label: "Delivery Address",
      description: "Address (shipping address).",
      optional: true,
    },
    deliveryPostalCode: {
      type: "string",
      label: "Delivery Postal Code",
      description: "Postal code (shipping address).",
      optional: true,
    },
    deliveryCity: {
      type: "string",
      label: "Delivery City",
      description: "City (shipping address).",
      optional: true,
    },
    deliveryCountry: {
      type: "string",
      label: "Delivery Country",
      description: "Any ISO 3166 Alpha-2 country code (shipping address).",
      optional: true,
    },
    paymentConditions: {
      type: "string",
      label: "Payment Conditions",
      description: "Customer payment conditions",
      options: PAYMENT_CONDITIONS_OPTIONS,
      optional: true,
    },
    phone: {
      type: "string",
      label: "Phone",
      description: "Customer phone number.",
      optional: true,
    },
    reference: {
      type: "string",
      label: "Reference",
      description: "This reference doesn't appear on the invoice.",
      optional: true,
    },
    notes: {
      type: "string",
      label: "Notes",
      description: "Notes about the customer.",
      optional: true,
    },
    mandate: {
      type: "object",
      label: "Mandate",
      description: "The mandate object. **Example: {\"provider\": \"gocardless\",\"source_id\": \"MD001H23WP8E7XN\"}**.",
      optional: true,
    },
    planItem: {
      type: "object",
      label: "Plan Item",
      description: "The plan item object. **Example: {\"enabled\": true,\"number\": \"123\",\"label\": \"label\",\"vat_rate\": \"123\",\"country_alpha2\": \"US\",\"description\": \"description\"}**.",
      optional: true,
    },
  },
  async additionalProps(props) {
    const typeCompany = (this.customerType === "company");
    props.name.hidden = !typeCompany;
    props.regNo.hidden = !typeCompany;
    props.recipient.hidden = !typeCompany;
    props.vatNumber.hidden = !typeCompany;
    props.firstName.hidden = typeCompany;
    props.lastName.hidden = typeCompany;
    props.gender.hidden = typeCompany;
    return {};
  },
  async run({ $ }) {
    try {
      const additionalData = this.customerType === "company"
        ? {
          name: this.name,
          reg_no: this.regNo,
          vat_number: this.vatNumber,
          recipient: this.recipient,
        }
        : {
          first_name: this.firstName,
          last_name: this.lastName,
          gender: this.gender,
        };

      const response = await this.pennylane.createCustomer({
        $,
        data: {
          customer: {
            customer_type: this.customerType,
            address: this.address,
            postal_code: this.postalCode,
            city: this.city,
            country_alpha2: this.country,
            source_id: this.sourceId,
            emails: parseObject(this.emails),
            billing_iban: this.billingIban,
            delivery_address: this.deliveryAddress,
            delivery_postal_code: this.deliveryPostalCode,
            delivery_city: this.deliveryCity,
            delivery_country_alpha2: this.deliveryCountry,
            payment_conditions: this.paymentConditions,
            phone: this.phone,
            reference: this.reference,
            notes: this.notes,
            mandate: parseObject(this.mandate),
            plan_item: parseObject(this.planItem),
            ...additionalData,
          },
        },
      });
      $.export("$summary", `Successfully created customer with Id: ${response.customer.source_id}`);
      return response;
    } catch ({ response }) {
      throw new ConfigurationError(response?.data?.message || response?.data?.error);
    }
  },
};

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
Pennylane	`pennylane`	`app`	This component uses the Pennylane app.
Customer Type	`customerType`	`string`	Select a value from the drop down menu:`companyindividual`
Address	`address`	`string`	Customer address (billing address).
Postal Code	`postalCode`	`string`	Postal code (billing address).
City	`city`	`string`	City (billing address).
Country	`country`	`string`	Any ISO 3166 Alpha-2 country code (billing address).
Source Id	`sourceId`	`string`	You can use your own id when creating the customer. If not provided, Pennylane will pick one for you. Id must be unique.
Emails	`emails`	`string[]`	A list of customer emails.
Billing IBAN	`billingIban`	`string`	The billing IBAN of the customer. This is the iban on which you wish to receive payment from this customer.
Delivery Address	`deliveryAddress`	`string`	Address (shipping address).
Delivery Postal Code	`deliveryPostalCode`	`string`	Postal code (shipping address).
Delivery City	`deliveryCity`	`string`	City (shipping address).
Delivery Country	`deliveryCountry`	`string`	Any ISO 3166 Alpha-2 country code (shipping address).
Payment Conditions	`paymentConditions`	`string`	Select a value from the drop down menu:`upon_receiptcustom15_days30_days45_days60_days`
Phone	`phone`	`string`	Customer phone number.
Reference	`reference`	`string`	This reference doesn't appear on the invoice.
Notes	`notes`	`string`	Notes about the customer.
Mandate	`mandate`	`object`	The mandate object. Example: {"provider": "gocardless","source_id": "MD001H23WP8E7XN"}.
Plan Item	`planItem`	`object`	The plan item object. Example: {"enabled": true,"number": "123","label": "label","vat_rate": "123","country_alpha2": "US","description": "description"}.

Action Authentication#

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

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

customer_invoices

About Pennylane#

Pennylane brings together your finances, your accounting, and your Business Account!

More Ways to Connect Pennylane + AWS#

Other Popular Integrations#

Create Customer with Pennylane API on New DynamoDB Stream Event from AWS API

AWS + Pennylane

Create Customer with Pennylane API on New Records Returned by CloudWatch Logs Insights Query from AWS API

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