Run Node Code with Node API on New Changes (Instant) from EspoCRM API

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

Trigger workflow on

New Changes (Instant) from the EspoCRM API

Next, do this

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

Select this integration
Configure the New Changes (Instant) trigger
1. Connect your EspoCRM account
2. Configure Entity Type
3. Optional- Select a Event Type
4. Optional- Configure Field
Configure the Run Node Code action
1. Connect your Node account
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 Changes (Instant) on EspoCRM

Description:Emit new event upon the creation, update, deletion, or changes of any field in an entity type. [See the documentation](https://docs.espocrm.com/administration/webhooks/)

Version:0.0.1

Key:espocrm-new-changes

View on GitHub

EspoCRM Overview#

The EspoCRM API allows for robust interaction with your CRM data, enabling the automation of tasks, syncing data across platforms, and the enhancement of customer relationship management through customized workflows. By leveraging this API within Pipedream, you can design serverless workflows that react to CRM events, integrate with other services, and manipulate data to fit your business processes. Pipedream's no-code platform makes it straightforward to create, execute, and maintain these workflows, allowing you to focus on innovation rather than infrastructure.

Trigger Code#

import espoCrm from "../../espocrm.app.mjs";
import constants from "../../common/constants.mjs";
import { ConfigurationError } from "@pipedream/platform";

export default {
  key: "espocrm-new-changes",
  name: "New Changes (Instant)",
  description: "Emit new event upon the creation, update, deletion, or changes of any field in an entity type. [See the documentation](https://docs.espocrm.com/administration/webhooks/)",
  version: "0.0.1",
  type: "source",
  dedupe: "unique",
  props: {
    espoCrm,
    db: "$.service.db",
    http: "$.interface.http",
    entityType: {
      type: "string",
      label: "Entity Type",
      description: "The entity type to watch. The list of available entity types can be obtained at Administration > Entity Manager.",
    },
    eventType: {
      type: "string",
      label: "Event Type",
      description: "Watch for this event type from the specified entity",
      options: constants.EVENT_TYPES,
      optional: true,
    },
    field: {
      type: "string",
      label: "Field",
      description: "Watch for changes to a specific field. The list of available fields can be obtained at Administration > Entity Manager > fields.",
      optional: true,
    },
  },
  hooks: {
    async activate() {
      if ((!this.eventType && !this.field) || (this.eventType && this.field)) {
        throw new ConfigurationError("One of `Event Type` or `Field` must be entered.");
      }
      const { id } = await this.espoCrm.createWebhook({
        data: {
          url: this.http.endpoint,
          event: this.field
            ? `${this.entityType}.fieldUpdate.${this.field}`
            : `${this.entityType}.${this.eventType}`,
        },
      });
      this._setHookId(id);
    },
    async deactivate() {
      const hookId = this._getHookId();
      if (hookId) {
        await this.espoCrm.deleteWebhook({
          hookId,
        });
      }
    },
  },
  methods: {
    _getHookId() {
      return this.db.get("hookId");
    },
    _setHookId(hookId) {
      this.db.set("hookId", hookId);
    },
  },
  async run(event) {
    const { body } = event;
    const ts = Date.now();
    this.$emit(body, {
      id: ts,
      summary: "New Event Received",
      ts,
    });
  },
};

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
EspoCRM	`espoCrm`	`app`	This component uses the EspoCRM 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.
Entity Type	`entityType`	`string`	The entity type to watch. The list of available entity types can be obtained at Administration > Entity Manager.
Event Type	`eventType`	`string`	Select a value from the drop down menu:`createupdatedelete`
Field	`field`	`string`	Watch for changes to a specific field. The list of available fields can be obtained at Administration > Entity Manager > fields.

Trigger Authentication#

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

About EspoCRM#

Open Source CRM. Easy to customize.

Action#

Run Node Code on Node

Description:Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the [Pipedream Node docs](https://pipedream.com/docs/code/nodejs) to learn more.

Version:0.0.2

Key:node-run-node-code

View on GitHub

Node Overview#

Develop, run and deploy your Node.js code in Pipedream workflows, using it between no-code steps, with connected accounts, or integrate Data Stores and File Stores.

This includes installing NPM packages, within your code without having to manage a package.json file or running npm install.

Below is an example of installing the axios package in a Pipedream Node.js code step. Pipedream imports the axios package, performs the API request, and shares the response with subsequent workflow steps:

Action Code#

import node from "../../node.app.mjs";

export default {
  name: "Run Node Code",
  version: "0.0.2",
  key: "node-run-node-code",
  description: "Write custom Node.js code and use any of the 400k+ npm packages available. Refer to the [Pipedream Node docs](https://pipedream.com/docs/code/nodejs) to learn more.",
  props: {
    node,
  },
  type: "action",
  methods: {},
  async run({
    steps, $,
  }) {
    // Return data to use it in future steps
    return steps.trigger.event;
  },
};