EspoCRM CRUD

Perform CRUD operations in EspoCRM
Join our community

Actions4

Overview

The EspoCRM CRUD node allows users to perform Create, Read, Update, and Delete operations on entities within an EspoCRM system via its REST API. This node is useful for automating data management tasks such as adding new contacts, retrieving account details, updating records, or deleting obsolete entries in EspoCRM.

Common scenarios include:

  • Creating new customer records automatically from form submissions.
  • Reading existing entity data to enrich workflows.
  • Updating records based on external triggers or data changes.
  • Deleting records that meet certain criteria to maintain data hygiene.

For example, you could use this node to create a new Contact entity by providing the contact details in JSON format, or update an Account entity’s information by specifying its record ID and the updated data.

Properties

Name Meaning
Operation The CRUD operation to perform: Create, Read, Update, or Delete.
Entity Type The type of entity to operate on, e.g., "Contact", "Account".
Record ID (Required for Read, Update, Delete) The unique identifier of the record to target.
Data (Required for Create, Update) The JSON-formatted data representing the entity's fields.

Output

The node outputs an array of JSON objects corresponding to each input item processed. Each output item contains:

  • json: The response data returned from the EspoCRM API for the performed operation. For example, after a Create operation, it will contain the newly created record’s details; after a Read operation, the retrieved entity data; after Update or Delete, confirmation or updated data.

The node does not output binary data.

Dependencies

  • Requires an active connection to an EspoCRM instance via its REST API.
  • Needs an API key credential for authentication with EspoCRM.
  • Uses HTTP headers including X-Api-Key for authorization and Content-Type: application/json.
  • The EspoCRM base URL must be configured in the credentials.

Troubleshooting

  • No credentials returned!
    This error occurs if the node cannot find or access the required API key credential. Ensure the credential is properly set up and selected.

  • Unknown operation error
    If an unsupported operation is specified, the node throws an error indicating the operation is unknown. Verify the operation property is one of Create, Read, Update, or Delete.

  • API request failures
    Network issues, incorrect URLs, invalid entity types, or malformed JSON data can cause API errors. Check the EspoCRM URL, entity names, and JSON syntax carefully.

  • Record ID missing for Read/Update/Delete
    These operations require a valid record ID. Omitting it will lead to errors or unexpected behavior.

  • To handle errors gracefully, enable the node’s “Continue On Fail” option to allow workflow execution to proceed even if some requests fail.

Links and References

Discussion