Capsule CRM v2

Provides integration with Capsule CRM to list, search, get, create, update and delete people and organisations, opportunities, projects, tasks and notes in your Workflows. The Node uses Capsule's API v2 with personal access token authentication and is available on Cloud Runtime Clusters.

Revision History

0.0.1.4 - Initial release.

Connection

Use this Connection to store the Capsule personal access token used to authenticate requests.

Setup Notes

1. Create a personal access token in Capsule under My Preferences → API Authentication Tokens.
2. Create a Capsule CRM Connection in Flowgear and enter the token in AccessToken.
3. Test the Connection. The test reads the current Capsule user within 30 seconds. It confirms that the token can authenticate and read, but does not check every write permission.
4. Select a Method and its operation template, then map the fields needed by your Workflow.

Requests use the fixed https://api.capsulecrm.com/api/v2/ endpoint. The Node does not refresh tokens. Replace the token on the Connection when it is revoked or expires.

Methods

Select an operation template for the Method you want to use. The template supplies OperationId, a GUID identifying that operation, and describes its Options, Items and Response fields. An OperationId from a different Method is rejected.

Capsule's API calls projects kases. Project fields and routes therefore keep Capsule's kase and kases spelling, while the templates use names such as List projects.

List

Lists records using the selected template. Subsequent pages are retrieved automatically as you consume Response.

Search

Searches parties, opportunities or projects using the selected template. Subsequent pages are retrieved automatically as you consume Response.

Get

Retrieves one record by its ID using the selected template.

Create

Creates one record for each input item. Supply the record's fields directly through Items; the Node adds Capsule's request wrapper, such as party or opportunity.

New entries are notes. Set type to note, supply the note content, and link it to exactly one party, opportunity or project.

Update

Updates the record identified in Options once for each input item. Fields omitted from an item are left unchanged. Explicit null values and empty arrays are sent to Capsule.

To update or remove nested contact details, tags or custom fields, include the nested item's id and, to remove it, _delete set to true, according to Capsule's rules for the selected operation.

Delete

Deletes the record identified in Options. This Method executes once per invocation and has no Items input.

Usage Notes

• Link related records using ID objects, such as "party": { "id": 123 }. The Node does not create related records inline.
• Use ISO 8601 date-time values for since, such as 2026-01-01T00:00:00Z.
• Supply embed and task status as CSV strings. For example, tags,fields for parties, opportunities or projects, party,owner for tasks, or open,completed for task status.
• Map string and integer collections as CSV strings. Quote values containing commas, quotes or line breaks, and double any quotes inside a quoted value. Whitespace is preserved. An empty string represents an empty collection, while "" represents one empty string. Integer values must be whole numbers without whitespace. Object collections remain structured.
• Custom field value accepts a string, boolean or number. Capsule returns number custom field values as strings. Multiselect custom field values use Capsule's semicolon-delimited format, not CSV.
• Recurring tasks use a repeat object containing frequency (YEARLY, MONTHLY or WEEKLY), interval and on. Omit repeat in an update to keep the existing recurrence, or set it to null to remove it.
• Let the Node handle pagination. Do not add page or perPage to Options.
• Consume the response stream to process all list and search pages or all create and update items. The first page or write executes when the Node starts; later pages and items are processed as the stream advances.
• Check Flowgear.IsSuccess for every mutation result. Record-level errors after the first item produce a failed row and allow later input items to continue. A failure on the first request, authentication failures and transport failures stop the Node.
• Capsule allows 4,000 requests per hour per user. Rate-limited requests are retried up to twice when the wait is no longer than two minutes; longer waits stop the Node with a message to retry later. Writes are not automatically retried after server errors or interrupted requests. Check Capsule before repeating a write because the request may already have succeeded.
• Templates are available without contacting Capsule. Their availability does not establish that your token can execute an operation. Account-specific field choices and business validation are enforced by Capsule.

Examples

Search parties

Select the Search template Search parties and supply the following Options object:

{
  "q": "Scott",
  "embed": "tags,fields"
}

Each row in Response is one matching person or organisation.

Create an organisation

Select the Create template Create party and supply the following object as an item in Items:

{
  "type": "organisation",
  "name": "Example Company"
}

Check the result's Flowgear.IsSuccess before using the returned id in later operations.

See also

• Capsule API v2 documentation.