Create Customer with Pennylane API on New Scheduled Tasks from Pipedream API

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

Trigger workflow on

New Scheduled Tasks from the Pipedream 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 Pipedream 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 Scheduled Tasks trigger
1. Connect your Pipedream account
2. Optional- Configure Secret
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 Scheduled Tasks on Pipedream

Description:Exposes an HTTP API for scheduling messages to be emitted at a future time

Version:0.3.1

Key:pipedream-new-scheduled-tasks

View on GitHub

Pipedream Overview#

Pipedream is an API that allows you to build applications that can connect to
various data sources and processes them in real-time. You can use Pipedream to
create applications that can perform ETL (Extract, Transform, and Load) tasks,
as well as to create data-driven workflows.

Some examples of applications you can build using the Pipedream API include:

An application that can extract data from a database, transform it, and then
load it into another database.
An application that can monitor a data source for changes, and then trigger a
workflow in response to those changes.
An application that can poll an API for new data, and then process that data
in real-time.

Trigger Code#

import pipedream from "../../pipedream.app.mjs";
import sampleEmit from "./test-event.mjs";
import { uuid } from "uuidv4";

export default {
  key: "pipedream-new-scheduled-tasks",
  name: "New Scheduled Tasks",
  type: "source",
  description:
    "Exposes an HTTP API for scheduling messages to be emitted at a future time",
  version: "0.3.1",
  dedupe: "unique", // Dedupe on a UUID generated for every scheduled task
  props: {
    pipedream,
    secret: {
      type: "string",
      secret: true,
      label: "Secret",
      optional: true,
      description:
        "**Optional but recommended**: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests",
    },
    http: {
      label: "Endpoint",
      description: "The endpoint where you'll send task scheduler requests",
      type: "$.interface.http",
      customResponse: true,
    },
    db: "$.service.db",
  },
  methods: {
    // To schedule future emits, we emit to the selfChannel of the component
    selfChannel() {
      return "self";
    },
    // Queue for future emits that haven't yet been delivered
    queuedEventsChannel() {
      return "$in";
    },
    httpRespond({
      status, body,
    }) {
      this.http.respond({
        headers: {
          "content-type": "application/json",
        },
        status,
        body,
      });
    },
    async selfSubscribe() {
      // Subscribe the component to itself. We do this here because even in
      // the activate hook, the component isn't available to take subscriptions.
      // Scheduled tasks are sent to the self channel, which emits the message at
      // the specified delivery_ts to this component.
      const isSubscribedToSelf = this.db.get("isSubscribedToSelf");
      if (!isSubscribedToSelf) {
        const componentId = process.env.PD_COMPONENT;
        const selfChannel = this.selfChannel();
        console.log(`Subscribing to ${selfChannel} channel for event source`);
        console.log(
          await this.pipedream.subscribe(componentId, componentId, selfChannel),
        );
        this.db.set("isSubscribedToSelf", true);
      }
    },
    validateEventBody(event, operation) {
      const errors = [];

      // Secrets are optional, so we first check if the user configured
      // a secret, then check its value against the prop (validation below)
      if (this.secret && event.headers["x-pd-secret"] !== this.secret) {
        errors.push(
          "Secret on incoming request doesn't match the configured secret",
        );
      }

      if (operation === "schedule") {
        const {
          timestamp,
          message,
        } = event.body;
        // timestamp should be an ISO 8601 string. Parse and check for validity below.
        const epoch = Date.parse(timestamp);

        if (!timestamp) {
          errors.push(
            "No timestamp included in payload. Please provide an ISO8601 timestamp in the 'timestamp' field",
          );
        }
        if (timestamp && !epoch) {
          errors.push("Timestamp isn't a valid ISO 8601 string");
        }
        if (!message) {
          errors.push("No message passed in payload");
        }
      }

      return errors;
    },
    scheduleTask(event) {
      const errors = this.validateEventBody(event, "schedule");
      let status, body;

      if (errors.length) {
        console.log(errors);
        status = 400;
        body = {
          errors,
        };
      } else {
        const id = this.emitScheduleEvent(event.body, event.body.timestamp);
        status = 200;
        body = {
          msg: "Successfully scheduled task",
          id,
        };
      }

      this.httpRespond({
        status,
        body,
      });
    },
    emitScheduleEvent(event, timestamp) {
      const selfChannel = this.selfChannel();
      const epoch = Date.parse(timestamp);
      const $id = uuid();

      console.log(`Scheduled event to emit on: ${new Date(epoch)}`);

      this.$emit(
        {
          ...event,
          $channel: selfChannel,
          $id,
        },
        {
          name: selfChannel,
          id: $id,
          delivery_ts: epoch,
        },
      );

      return $id;
    },
    async cancelTask(event) {
      const errors = this.validateEventBody(event, "cancel");
      let status, msg;

      if (errors.length) {
        console.log(errors);
        status = 400;
        msg = "Secret on incoming request doesn't match the configured secret";
      } else {
        try {
          const id = event.body.id;
          const isCanceled = await this.deleteEvent(event);
          if (isCanceled) {
            status = 200;
            msg = `Cancelled scheduled task for event ${id}`;
          } else {
            status = 404;
            msg = `No event with ${id} found`;
          }
        } catch (error) {
          console.log(error);
          status = 500;
          msg = "Failed to schedule task. Please see the logs";
        }
      }

      this.httpRespond({
        status,
        body: {
          msg,
        },
      });
    },
    async deleteEvent(event) {
      const componentId = process.env.PD_COMPONENT;
      const inChannel = this.queuedEventsChannel();

      // The user must pass a scheduled event UUID they'd like to cancel
      // We lookup the event by ID and delete it
      const { id } = event.body;

      // List events in the $in channel - the queue of scheduled events, to be emitted in the future
      const events = await this.pipedream.listEvents(
        componentId,
        inChannel,
      );
      console.log("Events: ", events);

      // Find the event in the list by id
      const eventToCancel = events.data.find((e) => {
        const { metadata } = e;
        return metadata.id === id;
      });

      console.log("Event to cancel: ", eventToCancel);

      if (!eventToCancel) {
        console.log(`No event with ${id} found`);
        return false;
      }

      // Delete the event
      await this.pipedream.deleteEvent(
        componentId,
        eventToCancel.id,
        inChannel,
      );
      return true;
    },
    emitEvent(event, summary) {
      // Delete the channel name and id from the incoming event, which were used only as metadata
      const id = event.$id;
      delete event.$channel;
      delete event.$id;

      this.$emit(event, {
        summary: summary ?? JSON.stringify(event),
        id,
        ts: +new Date(),
      });
    },
  },
  async run(event) {
    await this.selfSubscribe();

    const { path } = event;
    if (path === "/schedule") {
      this.scheduleTask(event);
    } else if (path === "/cancel") {
      await this.cancelTask(event);
    } else if (event.$channel === this.selfChannel()) {
      this.emitEvent(event);
    }
  },
  sampleEmit,
};

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
Pipedream	`pipedream`	`app`	This component uses the Pipedream app.
Secret	`secret`	`string`	Optional but recommended: if you enter a secret here, you must pass this value in the `x-pd-secret` HTTP header when making requests
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.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.

Trigger Authentication#

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

About Pipedream#

Integration platform for developers

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 + Pipedream#

Other Popular Integrations#

Create Billing Subscription with Pennylane API on New Scheduled Tasks from Pipedream API

Pipedream + Pennylane

Create Customer with Pennylane API on New Scheduled Tasks from Pipedream API

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