Create Estimate with Clientary API on New Payment Event (Instant) from PayPal API

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

Trigger workflow on

New Payment Event (Instant) from the PayPal API

Next, do this

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

Select this integration
Configure the New Payment Event (Instant) trigger
1. Connect your PayPal account
2. Select one or more Payment Event Types
Configure the Create Estimate action
1. Connect your Clientary account
2. Configure Date
3. Configure Currency Code
4. Optional- Configure Number
5. Optional- Configure Estimate Items Attributes
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 Payment Event (Instant) on PayPal

Description:Emits a new event on a new payment webhook event. [See webhooks docs here](https://developer.paypal.com/docs/api/webhooks/v1/#webhooks_post) and [Events Types docs here](https://developer.paypal.com/docs/api/webhooks/v1/#webhooks-event-types_list)

Version:0.0.1

Key:paypal-new-payment-event

View on GitHub

PayPal Overview#

The PayPal API on Pipedream allows you to automate payment processing, manage transactions, and streamline financial operations within your applications. By leveraging Pipedream's serverless platform, you can craft customized workflows that trigger on specific PayPal events, such as successful payments or disputes. Harness the power of automations to synchronize transaction data across diverse systems, send notifications, or even analyze financial trends.

Trigger Code#

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

export default {
  ...common,
  name: "New Payment Event (Instant)",
  version: "0.0.1",
  key: "paypal-new-payment-event",
  description: "Emits a new event on a new payment webhook event. [See webhooks docs here](https://developer.paypal.com/docs/api/webhooks/v1/#webhooks_post) and [Events Types docs here](https://developer.paypal.com/docs/api/webhooks/v1/#webhooks-event-types_list)",
  type: "source",
  dedupe: "unique",
  props: {
    ...common.props,
    paymentEventTypes: {
      propDefinition: [
        common.props.app,
        "paymentEventTypes",
      ],
      optional: false,
    },
  },
  methods: {
    ...common.methods,
    getWebhookEventTypes() {
      const events = this.paymentEventTypes === "string"
        ? JSON.parse(this.paymentEventTypes)
        : this.paymentEventTypes;

      return events.map((event) => ({
        name: event,
      }));
    },
    emitEvent(data) {
      this.$emit(data, {
        id: data.id,
        summary: `New payment event (${data.event_type}) with ID ${data.resource.id}`,
        ts: Date.parse(data.resource.create_time),
      });
    },
  },
};

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
PayPal	`app`	`app`	This component uses the PayPal app.
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.
Payment Event Types	`paymentEventTypes`	`string[]`	Select a value from the drop down menu.

Trigger Authentication#

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

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

About PayPal#

Send Money, Pay Online or Set Up a Merchant Account

Action#

Create Estimate on Clientary

Description:Creates a new estimate. [See docs here](https://www.clientary.com/api/estimates)

Version:0.0.1

Key:clientary-create-estimate

View on GitHub

Clientary Overview#

The Clientary API allows you to automate and integrate Clientary's project management, time tracking, and invoicing functionalities within Pipedream. By leveraging this API, you can create custom workflows to streamline operations, such as syncing new invoices with accounting software, triggering notifications based on project updates, or automating time tracking entries. Pipedream acts as the glue, enabling you to connect Clientary with hundreds of other apps to create sophisticated, serverless workflows tailored to your business needs.

Action Code#

import { defineAction } from "@pipedream/types";
import { ConfigurationError } from "@pipedream/platform";
import app from "../../app/clientary.app.mjs";
export default defineAction({
    key: "clientary-create-estimate",
    version: "0.0.1",
    name: "Create Estimate",
    description: "Creates a new estimate. [See docs here](https://www.clientary.com/api/estimates)",
    type: "action",
    props: {
        app,
        date: {
            type: "string",
            label: "Date",
            description: "The date of the estimate, e.g. `2022/11/17`",
        },
        currencyCode: {
            type: "string",
            label: "Currency Code",
            description: "Currency Code, e.g. `USD`, `EUR`",
        },
        number: {
            type: "string",
            label: "Number",
            description: "Estimate number. Must be unique, e.g. `101`",
            optional: true,
        },
        estimateItemsAttributes: {
            type: "string",
            label: "Estimate Items Attributes",
            description: "Estimate items attributes. Must be a valid JSON Array string, e.g. `[ { \"title\": \"foo\", \"quantity\": 1, \"price\": 100 }, { \"title\": \"bar\", \"quantity\": 2, \"price\": 200 } ]`",
            optional: true,
        },
    },
    async run({ $ }) {
        let estimateItemsAttributes;
        if (this.estimateItemsAttributes) {
            try {
                estimateItemsAttributes = JSON.parse(this.estimateItemsAttributes);
            }
            catch (err) {
                throw new ConfigurationError("`Estimate Items Attributes` must be a valid JSON Array string");
            }
        }
        const response = await this.app.getRequestMethod("createEstimate")({
            $,
            data: {
                date: this.date,
                currency_code: this.currencyCode,
                number: this.number,
                estimate_items_attributes: estimateItemsAttributes,
            },
        });
        $.export("$summary", `Successfully created an estimate (ID: ${response.id})`);
        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
Clientary	`app`	`app`	This component uses the Clientary app.
Date	`date`	`string`	The date of the estimate, e.g. `2022/11/17`
Currency Code	`currencyCode`	`string`	Currency Code, e.g. `USD`, `EUR`
Number	`number`	`string`	Estimate number. Must be unique, e.g. `101`
Estimate Items Attributes	`estimateItemsAttributes`	`string`	Estimate items attributes. Must be a valid JSON Array string, e.g. `[ { "title": "foo", "quantity": 1, "price": 100 }, { "title": "bar", "quantity": 2, "price": 200 } ]`

Action Authentication#

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

To connect your Clientary account with Pipedream,

Find your Clientary domain and paste it below. If the full URL is https://mygreatcompany.clientary.com, your domain is mygreatcompany.
Go to your user profile page in Clientary. You can find this on the upper right corner after logging in.
Click to "Generate API Token" to generate a unique token. Copy and paste that token below.

Create Estimate with Clientary API on New Payment Event (Instant) from PayPal API

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