Overview
This node enables performing CRUD (Create, Read, Update, Delete) operations on entities within an EspoCRM instance via its REST API. It is useful for automating data management tasks such as creating new records, retrieving existing records, updating them, or deleting unwanted entries in EspoCRM.
Common scenarios include:
- Automatically adding new contacts or accounts from external sources.
- Fetching details of specific records to use in workflows.
- Updating customer information based on changes in other systems.
- Removing obsolete records programmatically.
For example, you could use this node to update a contact’s phone number when it changes in another system, or to delete leads that no longer qualify.
Properties
| Name | Meaning |
|---|---|
| Entity Type | The type of entity to perform the operation on, e.g., Contact, Account. |
| Record ID | The unique identifier of the record to read, update, or delete. Required for these ops. |
| Data | JSON-formatted data to send when creating or updating a record. |
Output
The node outputs an array of JSON objects corresponding to each input item processed. Each output item contains the response data returned by the EspoCRM API for the respective operation.
- For Create and Update, the output JSON includes the newly created or updated record data.
- For Read, it returns the requested record's data.
- For Delete, it returns the API response confirming deletion.
- In case of errors (if "Continue On Fail" is enabled), the output JSON will contain an
errorfield with the error message.
The node does not output binary data.
Dependencies
- Requires an active EspoCRM instance accessible via its REST API.
- Needs an API key credential for authentication with EspoCRM.
- Uses HTTP requests with JSON payloads to communicate with the EspoCRM API.
- No additional environment variables are required beyond the configured credentials.
Troubleshooting
- No credentials returned!: This error occurs if the node cannot find valid API credentials. Ensure the API key credential is properly set up and linked.
- Unknown operation error: If an unsupported operation is specified, the node throws an error. Use only Create, Read, Update, or Delete.
- HTTP request failures: Network issues, incorrect URLs, or invalid API keys can cause request errors. Verify the EspoCRM URL and API key correctness.
- Invalid JSON in Data property: When creating or updating, ensure the JSON data is well-formed; otherwise, the API may reject the request.
- To debug, enable "Continue On Fail" to capture errors per item without stopping the workflow.