Create Contact with FreeAgent API on New Table from PostgreSQL API

Pipedream makes it easy to connect APIs for FreeAgent, PostgreSQL and 3,000+ other apps remarkably fast.

Trigger workflow on

New Table from the PostgreSQL API

Next, do this

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

Select this integration
Configure the New Table trigger
1. Connect your PostgreSQL account
2. Configure Polling Interval
3. Select a Schema
Configure the Create Contact action
1. Connect your FreeAgent account
2. Optional- Configure First Name
3. Optional- Configure Last Name
4. Optional- Configure Organisation Name
5. Optional- Configure Email
6. Optional- Configure Billing Email
7. Optional- Configure Phone Number
8. Optional- Configure Mobile
9. Optional- Configure Address 1
10. Optional- Configure Address 2
11. Optional- Configure Address 3
12. Optional- Configure Town / City
13. Optional- Configure Region / State
14. Optional- Configure Postcode / ZIP
15. Optional- Configure Country
16. Optional- Configure Contact Name on Invoices
17. Optional- Configure Default Payment Terms (Days)
18. Optional- Select a Locale
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 Table on PostgreSQL

Description:Emit new event when a new table is added to the database. [See the documentation](https://node-postgres.com/features/queries)

Version:2.0.8

Key:postgresql-new-table

View on GitHub

PostgreSQL Overview#

On Pipedream, you can leverage the PostgreSQL app to create workflows that automate database operations, synchronize data across platforms, and react to database events in real-time. Think handling new row entries, updating records from webhooks, or even compiling reports on a set schedule. Pipedream's serverless platform provides a powerful way to connect PostgreSQL with a variety of apps, enabling you to create tailored automation that fits your specific needs.

Trigger Code#

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

export default {
  ...common,
  name: "New Table",
  key: "postgresql-new-table",
  description: "Emit new event when a new table is added to the database. [See the documentation](https://node-postgres.com/features/queries)",
  version: "2.0.8",
  type: "source",
  props: {
    ...common.props,
    schema: {
      propDefinition: [
        common.props.postgresql,
        "schema",
      ],
    },
  },
  async run() {
    const previousTables = this._getPreviousValues() || [];

    const tables = await this.postgresql.getTables(this.schema);

    const newTables = tables.filter((table) => !previousTables.includes(table));
    for (const table of newTables) {
      const meta = this.generateMeta(table);
      this.$emit(table, meta);
    }

    this._setPreviousValues(tables);
  },
};

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
PostgreSQL	`postgresql`	`app`	This component uses the PostgreSQL app.
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Polling Interval	`timer`	`$.interface.timer`	Pipedream will poll the API on this schedule
Schema	`schema`	`string`	Select a value from the drop down menu.

Trigger Authentication#

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

Connecting to Restricted Databases

Either enable the shared static IP for this account below, or configure a VPC to deploy any workflow in your workspace to a private network with a dedicated static IP. Learn more in our docs

SSL Setup

Configure SSL on your PostgreSQL database by providing the CA (Certificate Authority), and choosing between Full Verification, Verify Certificate Authority (CA), or Skip Verification. Skipping verification is not recommended as this has serious security implications

About PostgreSQL#

PostgreSQL is a free and open-source relational database management system emphasizing extensibility and SQL compliance.

Action#

Create Contact on FreeAgent

Description:Create a contact in FreeAgent. [See the documentation](https://dev.freeagent.com/docs/contacts#create-a-contact).

Version:0.0.1

Key:freeagent-create-contact

View on GitHub

FreeAgent Overview#

FreeAgent, a powerful accounting tool, offers an API enabling businesses to automate various aspects of financial management. With the FreeAgent API, you can create, read, update, and delete invoices, bills, expenses, and much more, directly through Pipedream. This allows for the creation of custom automations that can save time, reduce errors, and streamline financial operations.

Action Code#

import { ConfigurationError } from "@pipedream/platform";
import { LOCALE_OPTIONS } from "../../common/constants.mjs";
import { getId } from "../../common/utils.mjs";
import freeagent from "../../freeagent.app.mjs";

export default {
  key: "freeagent-create-contact",
  name: "Create Contact",
  description: "Create a contact in FreeAgent. [See the documentation](https://dev.freeagent.com/docs/contacts#create-a-contact).",
  version: "0.0.1",
  type: "action",
  annotations: {
    destructiveHint: false,
    openWorldHint: true,
    readOnlyHint: false,
  },
  props: {
    freeagent,
    firstName: {
      type: "string",
      label: "First Name",
      description: "The first name of the contact. Required if `Organisation Name` is not provided.",
      optional: true,
    },
    lastName: {
      type: "string",
      label: "Last Name",
      description: "The last name of the contact. Required if `Organisation Name` is not provided.",
      optional: true,
    },
    organisationName: {
      type: "string",
      label: "Organisation Name",
      description: "The name of the organisation. Required if `First Name` and `Last Name` are not provided.",
      optional: true,
    },
    email: {
      type: "string",
      label: "Email",
      description: "The email of the contact",
      optional: true,
    },
    billingEmail: {
      type: "string",
      label: "Billing Email",
      description: "The billing email of the contact",
      optional: true,
    },
    phoneNumber: {
      type: "string",
      label: "Phone Number",
      description: "The phone number of the contact",
      optional: true,
    },
    mobile: {
      type: "string",
      label: "Mobile",
      description: "The mobile number of the contact",
      optional: true,
    },
    address1: {
      type: "string",
      label: "Address 1",
      description: "The first address line of the contact",
      optional: true,
    },
    address2: {
      type: "string",
      label: "Address 2",
      description: "The second address line of the contact",
      optional: true,
    },
    address3: {
      type: "string",
      label: "Address 3",
      description: "The third address line of the contact",
      optional: true,
    },
    town: {
      type: "string",
      label: "Town / City",
      description: "The town or city of the contact",
      optional: true,
    },
    region: {
      type: "string",
      label: "Region / State",
      description: "The region or state of the contact",
      optional: true,
    },
    postcode: {
      type: "string",
      label: "Postcode / ZIP",
      description: "The postcode or ZIP code of the contact",
      optional: true,
    },
    country: {
      type: "string",
      label: "Country",
      description: "The country of the contact",
      optional: true,
    },
    contactNameOnInvoices: {
      type: "boolean",
      label: "Contact Name on Invoices",
      description: "If true, the contact name will be shown on invoices as well as the organization name.",
      optional: true,
    },
    defaultPaymentTermsInDays: {
      type: "integer",
      label: "Default Payment Terms (Days)",
      description: "The default payment terms in days for the contact",
      optional: true,
    },
    locale: {
      type: "string",
      label: "Locale",
      description: "Invoice/Estimate language",
      optional: true,
      options: LOCALE_OPTIONS,
    },
  },
  async run({ $ }) {
    const hasOrg = this.organisationName;
    const hasPerson = this.firstName && this.lastName;
    if (!hasOrg && !hasPerson) {
      throw new ConfigurationError("Provide either `Organisation Name` OR both `First Name` and `Last Name`.");
    }

    const response = await this.freeagent.createContact({
      $,
      data: {
        first_name: this.firstName,
        last_name: this.lastName,
        organisation_name: this.organisationName,
        email: this.email,
        billing_email: this.billingEmail,
        phone_number: this.phoneNumber,
        mobile: this.mobile,
        address1: this.address1,
        address2: this.address2,
        address3: this.address3,
        town: this.town,
        region: this.region,
        postcode: this.postcode,
        country: this.country,
        contact_name_on_invoices: this.contactNameOnInvoices,
        default_payment_terms_in_days: this.defaultPaymentTermsInDays,
        locale: this.locale,
      },
    });
    $.export("$summary", `Successfully created contact with ID: \`${getId(response.contact.url)}\``);
    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
FreeAgent	`freeagent`	`app`	This component uses the FreeAgent app.
First Name	`firstName`	`string`	The first name of the contact. Required if `Organisation Name` is not provided.
Last Name	`lastName`	`string`	The last name of the contact. Required if `Organisation Name` is not provided.
Organisation Name	`organisationName`	`string`	The name of the organisation. Required if `First Name` and `Last Name` are not provided.
Email	`email`	`string`	The email of the contact
Billing Email	`billingEmail`	`string`	The billing email of the contact
Phone Number	`phoneNumber`	`string`	The phone number of the contact
Mobile	`mobile`	`string`	The mobile number of the contact
Address 1	`address1`	`string`	The first address line of the contact
Address 2	`address2`	`string`	The second address line of the contact
Address 3	`address3`	`string`	The third address line of the contact
Town / City	`town`	`string`	The town or city of the contact
Region / State	`region`	`string`	The region or state of the contact
Postcode / ZIP	`postcode`	`string`	The postcode or ZIP code of the contact
Country	`country`	`string`	The country of the contact
Contact Name on Invoices	`contactNameOnInvoices`	`boolean`	If true, the contact name will be shown on invoices as well as the organization name.
Default Payment Terms (Days)	`defaultPaymentTermsInDays`	`integer`	The default payment terms in days for the contact
Locale	`locale`	`string`	Select a value from the drop down menu:`{ "label": "Bulgarian", "value": "bg" }{ "label": "Catalan", "value": "ca" }{ "label": "Welsh", "value": "cy" }{ "label": "Czech", "value": "cz" }{ "label": "German", "value": "de" }{ "label": "Danish", "value": "dk" }{ "label": "English (United States)", "value": "en-US" }{ "label": "Spanish", "value": "es" }{ "label": "Estonian", "value": "et" }{ "label": "Finnish", "value": "fi" }{ "label": "French", "value": "fr" }{ "label": "French (Belgium)", "value": "fr-BE" }{ "label": "French (Canada)", "value": "fr-CA" }{ "label": "Icelandic", "value": "is" }{ "label": "Italian", "value": "it" }{ "label": "Latvian", "value": "lv-LV" }{ "label": "Dutch", "value": "nl" }{ "label": "Dutch (Belgium)", "value": "nl-BE" }{ "label": "Norwegian", "value": "nk" }{ "label": "Polish", "value": "pl-PL" }{ "label": "Brazilian Portuguese", "value": "pt-BR" }{ "label": "Romanian", "value": "ro" }{ "label": "Serbian", "value": "rs" }{ "label": "Russian", "value": "ru" }{ "label": "Swedish", "value": "se" }{ "label": "Slovak", "value": "sk" }{ "label": "Turkish", "value": "tr" }`

Action Authentication#

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

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