Update Customer with Microsoft Dynamics 365 Business Central API API on New Remote Directory Watcher from SFTP (key-based auth) API

Pipedream makes it easy to connect APIs for Microsoft Dynamics 365 Business Central API, SFTP (key-based auth) and 2,000+ other apps remarkably fast.

Trigger workflow on

New Remote Directory Watcher from the SFTP (key-based auth) API

Next, do this

Update Customer with the Microsoft Dynamics 365 Business Central API API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 800,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

This integration creates a workflow with a SFTP (key-based auth) trigger and Microsoft Dynamics 365 Business Central API action. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Select this integration
Configure the New Remote Directory Watcher trigger
1. Connect your SFTP (key-based auth) account
2. Configure timer
3. Configure Root directory
4. Configure Maximum watcher depth
Configure the Update Customer action
1. Connect your Microsoft Dynamics 365 Business Central API account
2. Select a Company ID
3. Select a Customer ID
4. Optional- Configure Name
5. Optional- Configure Email
6. Optional- Configure Phone
7. Optional- Configure Street Address
8. Optional- Configure City
9. Optional- Configure State
10. Optional- Configure Postal Code
11. Optional- Configure Country
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 Remote Directory Watcher on SFTP (key-based auth)

Description:Emit new events when files get created, changed or deleted from a remote directory. [See the docs](https://github.com/theophilusx/ssh2-sftp-client#orgfac43d1)

Version:0.0.4

Key:sftp-watch-remote-directory

View on GitHub

SFTP (key-based auth) Overview#

The SFTP (key-based auth) app on Pipedream allows you to securely transfer and manage files over a network. It uses SSH for data transfer and provides the same level of security as SSH, without requiring password authentication, making automation workflows more secure and less prone to human error. You can automate file uploads, downloads, synchronization tasks, and efficiently manage your remote files in a serverless environment. Integrating this with other Pipedream-supported apps enables you to craft powerful and secure data flow systems.

Trigger Code#

import sftpApp from "../../sftp.app.mjs";
import { DEFAULT_POLLING_SOURCE_TIMER_INTERVAL } from "@pipedream/platform";

export default {
  key: "sftp-watch-remote-directory",
  name: "New Remote Directory Watcher",
  description: "Emit new events when files get created, changed or deleted from a remote directory. [See the docs](https://github.com/theophilusx/ssh2-sftp-client#orgfac43d1)",
  version: "0.0.4",
  type: "source",
  dedupe: "unique",
  props: {
    sftpApp,
    timer: {
      type: "$.interface.timer",
      default: {
        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
      },
    },
    db: "$.service.db",
    rootDirectory: {
      label: "Root directory",
      description: "Root directory to be watched. example: `/public`",
      type: "string",
      default: "/",
    },
    maxDepth: {
      label: "Maximum watcher depth",
      description: "Watch all subdirectories within of the root directory, considering the selected maximum depth.",
      type: "integer",
      min: 0,
    },
  },
  methods: {
    setFiles(files) {
      this.db.set("files", files);
    },
    getFiles() {
      return this.db.get("files") || [];
    },
    getChangesWithEvent(currentFiles, previousFiles) {
      const fileChanges = [];
      // deleted file detection;
      for (const prvFile of previousFiles) {
        const file = currentFiles.find((p) => p.path === prvFile.path);
        if (!file) {
          fileChanges.push({
            ...prvFile,
            event: "deleted",
          });
        }
      }
      // created, updated file detection;
      for (const file of currentFiles) {
        const prvFile = previousFiles.find((p) => p.path === file.path);
        if (prvFile) {
          // unchanged files (checking size and last update time)
          if (prvFile.size === file.size && prvFile.modifyTime === file.modifyTime) {
            continue;
          }
          // file has changed
          fileChanges.push({
            ...file,
            event: "updated",
          });
        } else {
          // new file detection
          fileChanges.push({
            ...file,
            event: "created",
          });
        }
      }
      return fileChanges;
    },
    async listDirectories(sftp, parent, currDepth) {
      const files = await sftp.list(parent);
      return files.filter((file) => file.type === "d")
        .map((directory) => ({
          ...directory,
          parent,
          path: `${parent}/${directory.name}`,
          depth: currDepth,
        }));
    },
    async listDirectoriesDeep(sftp, parent, maxDepth, currDepth) {
      if (currDepth > maxDepth) {
        return [];
      }
      const nextDepth = currDepth + 1;
      const rootDirectories = await this.listDirectories(sftp, parent, currDepth);
      const childrenDirectories = [];
      for (const item of rootDirectories) {
        const path = `${parent}/${item.name}`;
        const directories = await this.listDirectoriesDeep(sftp, path, maxDepth, nextDepth);
        childrenDirectories.push(...directories);
      }
      rootDirectories.push(...childrenDirectories);
      return rootDirectories;
    },
    async listAllFilesFromDirectories(sftp, directories) {
      const allFiles = [];
      for (const directory of directories) {
        const listingResult = await sftp.list(directory.path);
        const files = listingResult.filter((file) => file.type !== "d")
          .map((file) => ({
            ...file,
            directory: directory.path,
            path: `${directory.path}/${file.name}`,
            depth: directory.depth || 0,
          }));
        allFiles.push(...files);
      }
      return allFiles;
    },
    validateRootDirectory(rootDirectory) {
      if (!rootDirectory) {
        throw new Error("Must provide root directory");
      }
      if (!rootDirectory.startsWith("/")) {
        throw new Error("The root directory must to be the absolute path and start with a slash, such as: '/public'");
      }
    },
    getEventId(event) {
      return `${event.event}|${event.path}|${event.size}|${event.modifyTime}`;
    },
    emitEvents(events) {
      for (const fileChangeEvent of events) {
        this.$emit(fileChangeEvent, {
          id: this.getEventId(fileChangeEvent),
          summary: `${fileChangeEvent.event} ${fileChangeEvent.path}`,
          ts: new Date(fileChangeEvent.modifyTime),
        });
      }
    },
    async connect() {
      return await this.sftpApp.connect();
    },
    async disconnect(sftp) {
      await sftp.end();
    },
  },
  async run() {
    this.validateRootDirectory(this.rootDirectory);

    const sftp = await this.connect();

    let directories = [
      {
        path: this.rootDirectory,
      },
    ];
    directories = directories.concat(
      await this.listDirectoriesDeep(sftp, this.rootDirectory, this.maxDepth, 0),
    );

    const currentFiles = await this.listAllFilesFromDirectories(sftp, directories);
    const previousFiles = this.getFiles();
    const filesChangesWithEvent = this.getChangesWithEvent(currentFiles, previousFiles);
    this.emitEvents(filesChangesWithEvent);

    this.setFiles(currentFiles);
    await this.disconnect(sftp);
  },
};

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
SFTP (key-based auth)	`sftpApp`	`app`	This component uses the SFTP (key-based auth) app.
	`timer`	`$.interface.timer`
N/A	`db`	`$.service.db`	This component uses `$.service.db` to maintain state between executions.
Root directory	`rootDirectory`	`string`	Root directory to be watched. example: `/public`
Maximum watcher depth	`maxDepth`	`integer`	Watch all subdirectories within of the root directory, considering the selected maximum depth.

Trigger Authentication#

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

This app holds details for an SFTP server you want to interact with in Pipedream.

Below, enter the hostname of the server you'd like to connect to, your username, and the private key you'd like to use to connect.

This app only supports key pair authentication, not authentication via password. If you need to use a username / password to connect to a host, please use the SFTP (password-based auth) app, instead.

About SFTP (key-based auth)#

Interact with an SFTP (SSH File Transfer Protocol) Server using a private key for auth

Action#

Update Customer on Microsoft Dynamics 365 Business Central API

Description:Updates an existing customer. [See the documentation](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_customer_update)

Version:0.0.1

Key:dynamics_365_business_central_api-update-customer

View on GitHub

Microsoft Dynamics 365 Business Central API Overview#

The Microsoft Dynamics 365 Business Central API enables you to streamline business processes by automating tasks and integrating with other services. With this API, you can access Dynamics 365 Business Central data such as financials, sales, service, and operations. It's perfect for creating custom workflows in Pipedream that can manipulate data, synchronize information across platforms, generate reports, and notify team members of important events.

Action Code#

import dynamics from "../../dynamics_365_business_central_api.app.mjs";
import utils from "../../common/utils.mjs";

export default {
  key: "dynamics_365_business_central_api-update-customer",
  name: "Update Customer",
  description: "Updates an existing customer. [See the documentation](https://learn.microsoft.com/en-us/dynamics365/business-central/dev-itpro/api-reference/v2.0/api/dynamics_customer_update)",
  version: "0.0.1",
  type: "action",
  props: {
    dynamics,
    companyId: {
      propDefinition: [
        dynamics,
        "companyId",
      ],
    },
    customerId: {
      propDefinition: [
        dynamics,
        "customerId",
        (c) => ({
          companyId: c.companyId,
        }),
      ],
    },
    name: {
      propDefinition: [
        dynamics,
        "name",
      ],
      optional: true,
    },
    email: {
      propDefinition: [
        dynamics,
        "email",
      ],
    },
    phone: {
      propDefinition: [
        dynamics,
        "phone",
      ],
    },
    address: {
      propDefinition: [
        dynamics,
        "address",
      ],
    },
    city: {
      propDefinition: [
        dynamics,
        "city",
      ],
    },
    state: {
      propDefinition: [
        dynamics,
        "state",
      ],
    },
    postalCode: {
      propDefinition: [
        dynamics,
        "postalCode",
      ],
    },
    country: {
      propDefinition: [
        dynamics,
        "country",
      ],
    },
  },
  methods: {
    async buildAddress($) {
      const { address } = await this.dynamics.getCustomer({
        companyId: this.companyId,
        customerId: this.customerId,
        $,
      });
      return {
        street: this.address || address.street,
        city: this.city || address.city,
        state: this.state || address.state,
        countryLetterCode: this.country || address.countryLetterCode,
        postalCode: this.postalCode || address.postalCode,
      };
    },
  },
  async run({ $ }) {
    const hasAddress = this.address
      || this.city
      || this.state
      || this.countryLetterCode
      || this.postalCode;
    const response = await this.dynamics.updateCustomer({
      $,
      companyId: this.companyId,
      customerId: this.customerId,
      data: utils.cleanObject({
        displayName: this.name,
        phoneNumber: this.phone,
        email: this.email,
        address: hasAddress
          ? await this.buildAddress($)
          : undefined,
      }),
    });
    $.export("$summary", `Successfully updated customer with ID ${this.customerId}`);
    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
Microsoft Dynamics 365 Business Central API	`dynamics`	`app`	This component uses the Microsoft Dynamics 365 Business Central API app.
Company ID	`companyId`	`string`	Select a value from the drop down menu.
Customer ID	`customerId`	`string`	Select a value from the drop down menu.
Name	`name`	`string`	The name of the customer
Email	`email`	`string`	Email address of the customer
Phone	`phone`	`string`	Phone number of the customer
Street Address	`address`	`string`	Street address of the customer
City	`city`	`string`	City of the customer
State	`state`	`string`	State of the customer
Postal Code	`postalCode`	`string`	Postal code of the customer
Country	`country`	`string`	Country of the customer

Action Authentication#

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

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

User.Reademailoffline_accessopenidprofileFinancials.ReadWrite.All