Connect AI agents to Dynamo Software

Scalekit connector

The Dynamo Software connector lets your AI agent act in each user's Dynamo Software account. Each user connects their own Dynamo Software access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 36 tools.

Tools: 36
What they doRead · write · destructive: 21 · 12 · 321 read12 write3 destructive
Users sign in with: Access token

What you can do

Read entity data: list, look up, and count items in any Dynamo entity with filters and sorting
Create and update items: add or update single items, or create, update, and delete many at once
Manage documents: upload, version, update, and delete documents and check upload restrictions
Query views and saved searches: pull data from Dynamo views, SQL views, and saved search criteria
Trigger workflows: run workflow action buttons, custom operations, and scheduled workflows on demand
Explore schemas: list entities and inspect their properties and schema definitions

Setup

Install the SDK
- Node.js
- Python
Terminal window
npm install @scalekit-sdk/node dotenv
Terminal window
pip install scalekit-sdk-python python-dotenv
Set your credentials
Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.
.env
```
SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
SCALEKIT_CLIENT_ID=<your-client-id>
SCALEKIT_CLIENT_SECRET=<your-client-secret>
```
Create the Dynamo Software connection
In AgentKit > Connections, create a Dynamo Software connection. The name you give it is the connection_name your code passes. See Configure connections.

Authorize a user and make your first call

Node.js
Python

1
import { ScalekitClient } from '@scalekit-sdk/node'
2
import 'dotenv/config'
3
import { createInterface } from 'node:readline/promises'
4

5
const scalekit = new ScalekitClient(
6
  process.env.SCALEKIT_ENVIRONMENT_URL,
7
  process.env.SCALEKIT_CLIENT_ID,
8
  process.env.SCALEKIT_CLIENT_SECRET,
9
)
10
const actions = scalekit.actions
11

12
const connector = 'dynamo'
13
const identifier = 'user_123'
14

15
// Generate an authorization link for the user
16
const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
17
console.log('Authorize Dynamo Software:', link)
18
const rl = createInterface({ input: process.stdin, output: process.stdout })
19
await rl.question('Press Enter after authorizing...')
20
rl.close()
21

22
// Make your first call
23
const result = await actions.executeTool({
24
  connector,
25
  identifier,
26
  toolName: 'dynamo_get_document_extended_schema',
27
  toolInput: {},
28
})
29
console.log(result)

npx tsx quickstart.mts

1
import os
2
from scalekit import ScalekitClient
3
from dotenv import load_dotenv
4
load_dotenv()
5

6
scalekit_client = ScalekitClient(
7
    env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),
8
    client_id=os.getenv("SCALEKIT_CLIENT_ID"),
9
    client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
10
)
11
actions = scalekit_client.actions
12

13
connection_name = "dynamo"
14
identifier = "user_123"
15

16
# Generate an authorization link for the user
17
link_response = actions.get_authorization_link(
18
    connection_name=connection_name,
19
    identifier=identifier,
20
)
21
print("Authorize Dynamo Software:", link_response.link)
22
input("Press Enter after authorizing...")
23

24
# Make your first call
25
result = actions.execute_tool(
26
    tool_input={},
27
    tool_name="dynamo_get_document_extended_schema",
28
    connection_name=connection_name,
29
    identifier=identifier,
30
)
31
print(result)

python quickstart.py

Each user opens the link once and enters their Dynamo Software credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool

Try in Playground Request a tool

dynamo_decrypt_propertyReturns decrypted value of an encrypted property for a given entity record.Read-only
Decrypt Entity Property
Returns decrypted value of an encrypted property for a given entity record.
Inputs
entityNamestringrequired
The name of the Dynamo entity that contains the encrypted property (e.g., 'Contact', 'Activity').
idstringrequired
The unique identifier (UUID/entity key) of the specific entity record whose encrypted property you want to decrypt.
propertystringrequired
The name of the encrypted property to decrypt. Must be a property that is configured as encrypted in Dynamo.
dynamo_entity_by_idReturns a single instance of a Dynamo entity by its ID with optional column selection and formatting controls.Read-only
Get Entity By ID
Returns a single instance of a Dynamo entity by its ID with optional column selection and formatting controls.
Inputs
entityNamestringrequired
The name of the Dynamo entity type to retrieve a record from (e.g., 'activity', 'contact').
idstringrequired
The unique identifier (UUID) of the specific entity record to retrieve.
x_columnsstring
Comma-separated list of property names to include in the response. Reduces bandwidth by returning only specified fields.
x_columns_encodedboolean
When true, the x_columns value must be provided as a base64-encoded string. Default is false.
x_resolvedboolean
When false, reference/lookup properties are returned as raw objects (with _id and _es) instead of resolved display values. Default is true.
x_showlabelsboolean
When true, property keys in the response use display labels instead of internal property names. Default is false.
dynamo_entity_extended_schemaReturns the extended schema definition of a specified Dynamo entity, including detailed metadata and optional permissions.Read-only
Get Extended Entity Schema
Returns the extended schema definition of a specified Dynamo entity, including detailed metadata and optional permissions.
Inputs
entityNamestringrequired
The name of the Dynamo entity to retrieve the extended schema for (e.g., 'activity', 'contact', 'document').
permissionsboolean
When true, the schema response includes information about the current user's permissions to perform operations on each property. Default is false.
dynamo_entity_propertiesReturns all properties for a specified Dynamo entity.Read-only
Get Entity Properties
Returns all properties for a specified Dynamo entity.
Inputs
entityNamestringrequired
The name of the Dynamo entity whose properties (field list) you want to retrieve.
dynamo_entity_schemaReturns the schema definition of a specified Dynamo entity.Read-only
Get Entity Schema
Returns the schema definition of a specified Dynamo entity.
Inputs
entityNamestringrequired
The name of the Dynamo entity whose field schema you want to retrieve (e.g., 'activity', 'contact', 'document').
permissionsboolean
When true, the schema response includes information about the current user's permissions to perform operations on each property. Default is false.
dynamo_entity_totalReturns total count of items for a given Dynamo entity.Read-only
Get Entity Total Count
Returns total count of items for a given Dynamo entity.
Inputs
entityNamestringrequired
The name of the Dynamo entity whose total record count you want to retrieve.
dynamo_get_document_by_idReturns a single Dynamo document by its unique ID with optional column filtering and formatting controls.Read-only
Get Document By ID
Returns a single Dynamo document by its unique ID with optional column filtering and formatting controls.
Inputs
idstringrequired
The unique identifier (UUID) of the document to retrieve.
x_columnsstring
Comma-separated list of property names to include in the response. Reduces bandwidth.
x_columns_encodedboolean
When true, the x_columns value must be provided as a base64-encoded string. Default is false.default false
x_identifierboolean
When true, the response includes the Identifier property (Name (ID)) for the document. Default is true.
x_resolvedboolean
When false, reference/lookup properties are returned as raw objects (with _id and _es) instead of resolved display values. Default is true.default true
x_showlabelsboolean
When true, property keys in the response use display labels instead of internal property names. Default is false.
dynamo_get_document_extended_schemaReturns an extended schema of the Dynamo Document entity, including detailed metadata and optional permission information.Read-only
Get Document Extended Schema
Returns an extended schema of the Dynamo Document entity, including detailed metadata and optional permission information.
Inputs
permissionsboolean
When true, the extended schema response includes information about the current user's permissions to perform operations on each property. Default is false.
dynamo_get_document_propertiesReturns all properties available for the document entity in Dynamo.Read-only
Get Document Properties
Returns all properties available for the document entity in Dynamo.
Inputs
This tool takes no inputs.
dynamo_get_document_schemaReturns the schema definition of the Dynamo document entity, optionally including permission metadata.Read-only
Get Document Schema
Returns the schema definition of the Dynamo document entity, optionally including permission metadata.
Inputs
permissionsboolean
When true, the schema response includes information about the current user's permissions to perform operations on each document property. Default is false.
dynamo_get_document_upload_restrictionsReturns upload restrictions for Dynamo Document entity such as size limits, allowed types, and validation rules.Read-only
Get Document Upload Restrictions
Returns upload restrictions for Dynamo Document entity such as size limits, allowed types, and validation rules.
Inputs
This tool takes no inputs.
dynamo_get_documentsRetrieve documents from Dynamo with filters, sorting, pagination.Read-only
Get Documents
Retrieve documents from Dynamo with filters, sorting, pagination.
Inputs
idstring
Optional document UUID. When provided, the response contains only the document matching this ID.
x_columnsstring
Comma-separated list of property names to include in the response. Reduces bandwidth by returning only specified fields.
x_columns_encodedboolean
When true, the x_columns value must be provided as a base64-encoded string. Default is false.default false
x_resolvedboolean
When false, reference/lookup properties are returned as raw objects (with _id and _es) instead of resolved display values. Default is true.default true
x_showlabelsboolean
When true, property keys in the response use display labels instead of internal property names. Default is false.
x_sortstring
Sorting expression for the returned documents. Supports single or multiple property sort with direction.
x_sort_encodedboolean
When true, the x_sort value must be provided as a base64-encoded string. Default is false.default false
dynamo_get_documents_totalReturns the total number of document entities in Dynamo.Read-only
Get Documents Total Count
Returns the total number of document entities in Dynamo.
Inputs
This tool takes no inputs.
dynamo_get_entitiesReturns all available Dynamo entities with optional filtering support.Read-only
Get All Entities
Returns all available Dynamo entities with optional filtering support.
Inputs
x_filterstring
Filter entities whose properties match the given criteria. Format: propertyA=value1, propertyB=value2.
dynamo_get_entity_itemsReturns all items for a given Dynamo entity with support for filtering, pagination, sorting, and column selection.Read-only
Get Entity Items
Returns all items for a given Dynamo entity with support for filtering, pagination, sorting, and column selection.
Inputs
entityNamestringrequired
The name of the Dynamo entity type to retrieve records from (e.g., 'activity', 'contact', 'document').
idstring
Optional UUID to filter to a single entity record. When provided, only the record matching this ID is returned.
x_columnsstring
Comma-separated list of property names to include in the response. Reduces bandwidth by returning only specified fields.
x_columns_encodedboolean
When true, the x_columns value must be provided as a base64-encoded string. Default is false.default false
x_resolvedboolean
When false, reference/lookup properties are returned as raw objects (with _id and _es) instead of resolved display values. Default is true.default true
x_showlabelsboolean
When true, property keys in the response use display labels instead of internal property names. Default is false.
x_sortstring
Sorting expression for the returned records. Supports single or multiple property sort with direction.
x_sort_encodedboolean
When true, the x_sort value must be provided as a base64-encoded string. Default is false.default false
dynamo_get_entity_schemaReturns a brief schema for all available Dynamo entities with optional filtering, permission details, and extended metadata.Read-only
Get Entity Schema
Returns a brief schema for all available Dynamo entities with optional filtering, permission details, and extended metadata.
Inputs
fullboolean
When true, returns the complete schema containing all properties that can be passed to the x-filter parameter. Default is false.
permissionsboolean
When true, each entity schema includes the current user's permissions to perform operations on that entity. Default is false.
showConfirmDeleteboolean
When true, the schema response includes the showConfirmDelete property for each entity. Default is false.
showSubtitleboolean
When true, the schema response includes the Subtitle property name for each entity. Default is false.
x_filterstring
Filters entities whose properties match the given schema criteria. Format: propertyA=value1, propertyB=value2.
dynamo_searchRetrieves data matching saved search criteria from Dynamo using advanced filter queries.Read-only
Search Entities
Retrieves data matching saved search criteria from Dynamo using advanced filter queries.
Inputs
querystringrequired
JSON-formatted advanced search query in Dynamo's 'advf' format. Copy this from the Dynamo site's advanced search panel using the 'API Query' button.
allboolean
When true, returns all matching results across all pages instead of only the first page. Use with caution for large result sets.
utcOffsetnumber
The difference in hours from Coordinated Universal Time (UTC) to use for date/time calculations in the search. Default is 0 (UTC).default 0
x_columnsstring
Comma-separated list of property names to include in each result. Reduces bandwidth.
x_columns_encodedboolean
When true, the x_columns value must be provided as a base64-encoded string. Default is false.default false
x_resolvedboolean
When false, reference/lookup properties are returned as raw objects (with _id and _es) instead of resolved display values. Default is true.default true
x_showlabelsboolean
When true, property keys in the response use display labels instead of internal property names. Default is false.
x_sortstring
Sorting expression for the search results. Supports single or multiple property sort.
x_sort_encodedboolean
When true, the x_sort value must be provided as a base64-encoded string. Default is false.default false
dynamo_view_getReturns available views or items from a specified view with optional filtering, sorting, and column selection.Read-only
Get Views
Returns available views or items from a specified view with optional filtering, sorting, and column selection.
Inputs
pathstring
The path identifier of the view. If provided, returns all items matching that view's search criteria. If omitted, returns a list of all available views.
utcOffsetnumber
The difference in hours from Coordinated Universal Time (UTC) for date/time calculations. Default is 0 (UTC).default 0
x_columnsstring
Comma-separated list of additional property names to include in the response alongside the view's default columns.
x_columns_encodedboolean
When true, the x_columns value must be provided as a base64-encoded string. Default is false.default false
x_resolvedboolean
When false, reference/lookup properties are returned as raw objects (with _id and _es) instead of resolved display values. Default is true.default true
x_showlabelsboolean
When true, property keys in the response use display labels instead of internal property names. Default is false.
x_sortstring
Sort expression that overrides the view's default sorting with higher priority.
x_sort_encodedboolean
When true, the x_sort value must be provided as a base64-encoded string. Default is false.default false
dynamo_view_postRetrieves items from a specified Dynamo view using optional filters and query rules.Read-only
Search View
Retrieves items from a specified Dynamo view using optional filters and query rules.
Inputs
pathstringrequired
The path identifier of the view to search. Required. Combined with optional filter rules in the request body to retrieve matching items.
querystring
JSON string representing additional filter rules to apply on top of the view's built-in search criteria. If omitted, only the view's default criteria are used.
utcOffsetnumber
The difference in hours from Coordinated Universal Time (UTC) for date/time calculations. Default is 0 (UTC).default 0
x_columnsstring
Comma-separated list of additional property names to include in the response alongside the view's default columns.
x_columns_encodedboolean
When true, the x_columns value must be provided as a base64-encoded string. Default is false.default false
x_resolvedboolean
When false, reference/lookup properties are returned as raw objects (with _id and _es) instead of resolved display values. Default is true.default true
x_showlabelsboolean
When true, property keys in the response use display labels instead of internal property names. Default is false.
x_sortstring
Sort expression that overrides the view's default sorting with higher priority.
x_sort_encodedboolean
When true, the x_sort value must be provided as a base64-encoded string. Default is false.default false
dynamo_view_sqlReturns a list of available SQL views from Dynamo.Read-only
Get SQL Views
Returns a list of available SQL views from Dynamo.
Inputs
This tool takes no inputs.
dynamo_view_sql_get_by_nameReturns data from a specific SQL view in Dynamo using the view name.Read-only
Get SQL View By Name
Returns data from a specific SQL view in Dynamo using the view name.
Inputs
viewNamestringrequired
The name of the SQL view to retrieve, without the 'EXPORTSQL_' prefix. The API appends this prefix automatically when calling GET /api/v2.2/View/sql/EXPORTSQL_{viewName}.
dynamo_bulk_upsertCreate or update multiple entities in Dynamo Software using bulk import.Write
Bulk Upsert Entities
Create or update multiple entities in Dynamo Software using bulk import.
Inputs
entityNamestringrequired
The name of the Dynamo entity to bulk create or update records for (e.g., 'contact', 'activity').
itemsarrayrequired
A required array of entity objects to create or update. Each object should contain the key property values plus any additional fields to set.
keyPropertiesarrayrequired
A required set of property names which combined determine the unique identity of each entity for matching purposes.
importActionstring
Controls the import behavior. Default is 'updateorcreate'. 'create': only creates new records; 'update': only updates existing matches; 'updateorcreate': updates if match found, creates if not.one of createupdateupdateorcreatedefault updateorcreate
skipColumnIfSourceHasNoValueboolean
Default false. When true, blank or null property values in the input are ignored and will not overwrite existing data. When false (default), blank values will clear existing property values.default false
skipIfPropertyHasNoValueboolean
Default true. When true, properties not present in a given item will not overwrite existing values for that item. When false, all items must contain the same properties and unspecified values will be overwritten.default true
dynamo_create_documentCreate a new document or update an existing one based on key columns in Dynamo.Write
Create Document
Create a new document or update an existing one based on key columns in Dynamo.
Inputs
titlestringrequired
The display title of the document. Required when creating a file upload (x_ishyperlink=false) or a hyperlink (x_ishyperlink=true).
contentstring
The document file contents encoded as a base64 string. Required when x_ishyperlink is false (default). Maps to the '_content' field in the API body.
extensionstring
The file extension of the document including the dot prefix. Required when x_ishyperlink is false.
hyperlinkstring
The URL for a hyperlink document. Required when x_ishyperlink is true. Must be a valid URL.
x_identifierboolean
When true, the response will include the Identifier property (Name (ID)) for the document. Default is true.
x_importactionstring
Controls the create/update behavior when x_keycolumns is provided. Default is 'updateorcreate'. Only applies when x_keycolumns is also set.one of createupdateupdateorcreatedefault updateorcreate
x_ishyperlinkboolean
When set to true, the document is created as a web link (hyperlink) instead of a file upload. Default is false.default false
x_keycolumnsstring
A set of comma-separated column names used to determine the identity of a specific document for upsert. The '_content' column cannot be used as a key column.
x_keycolumns_encodedboolean
When true, the x_keycolumns value must be provided as a base64-encoded string. Default is false.default false
x_resolvedboolean
When false, reference properties in the response are returned as objects (with _id and _es) instead of resolved primitive values. Default is true.default true
dynamo_entity_putCreates or updates an entity item in Dynamo using PUT semantics.Write
Upsert Entity Item
Creates or updates an entity item in Dynamo using PUT semantics. Supports key columns or ID-based upsert via headers or request body.
Inputs
bodyobjectrequired
The entity field values to create or update. Pass a JSON object with the Dynamo property names as keys.
entityNamestringrequired
The name of the Dynamo entity type to create or update (e.g., 'activity', 'contact', 'document').
x_identifierboolean
When true, the response includes the Identifier property (Name (ID)) for the entity. Default is true.
x_importactionstring
Controls the create/update behavior when x_keycolumns is set. Default is 'updateorcreate'. Only applies when x_keycolumns is also provided.one of createupdateupdateorcreatedefault updateorcreate
x_keycolumnsstring
Comma-separated column names used to determine the identity of a specific entity for upsert matching.
x_keycolumns_encodedboolean
When true, the x_keycolumns value must be provided as a base64-encoded string. Default is false.default false
x_resolvedboolean
When false, reference/lookup properties are returned as raw objects (with _id and _es) instead of resolved display values. Default is true.default true
dynamo_entity_update_by_idUpdates or creates an instance of a Dynamo entity identified by ID and returns the updated item.Write
Update Entity By ID
Updates or creates an instance of a Dynamo entity identified by ID and returns the updated item.
Inputs
bodyobjectrequired
Key-value pairs of entity properties to update. Property names must match the entity schema exactly. Example: {"Subject": "Follow-up call", "Body": "Discuss proposal"}
entityNamestringrequired
The name of the Dynamo entity type containing the record to update (e.g., 'activity', 'contact').
idstringrequired
The unique identifier (UUID) of the specific entity record to update or create.
x_identifierboolean
When true, the response includes the Identifier property (Name (ID)) for the entity. Default is true.
x_resolvedboolean
When false, reference/lookup properties in the response are returned as raw objects (with _id and _es) instead of resolved display values. Default is true.default true
dynamo_entity_upsertCreates or updates an entity item in Dynamo.Write
Create Entity Item
Creates or updates an entity item in Dynamo. Supports key-based upsert using headers or ID in request body.
Inputs
bodyobjectrequired
JSON object containing the entity field values to create or update. Property names must match Dynamo field names exactly.
entityNamestringrequired
The name of the Dynamo entity type to create or update a record for (e.g., 'activity', 'contact').
x_identifierboolean
When true, the response includes the Identifier property (Name (ID)) for the entity. Default is true.
x_importactionstring
Controls the create/update behavior when x_keycolumns is provided. Default is 'updateorcreate'.one of createupdateupdateorcreatedefault updateorcreate
x_keycolumnsstring
Comma-separated column names that together uniquely identify an entity for upsert matching.
x_keycolumns_encodedboolean
When true, the x_keycolumns value must be provided as a base64-encoded string. Default is false.default false
x_resolvedboolean
When false, reference/lookup properties in the response are returned as raw objects (with _id and _es) instead of resolved display values. Default is true.default true
dynamo_reset_api_keyRemoves the user's API key from the server cache.Write
Reset API Key Cache
Removes the user's API key from the server cache. The key remains valid but will be revalidated on next request.
- Idempotent
Inputs
This tool takes no inputs.
dynamo_update_documentCreates a new version of a Dynamo document by updating it using its ID.Write
Update Document By ID
Creates a new version of a Dynamo document by updating it using its ID. Optionally updates title or creates hyperlink versions.
Inputs
idstringrequired
The unique identifier (UUID) of the document to update.
_contentstring
The new document file content encoded as a base64 string. Providing this creates a new version of the document.
hyperlinkstring
The URL for a hyperlink document. Required when x-ishyperlink is true. Must be a valid URL.
titlestring
Optional new title for the document. When updated, the title change applies to ALL versions of the document, not just the current version.
x-identifierboolean
When true, the response includes the Identifier property (Name (ID)) for the document. Default is true.
x-ishyperlinkboolean
When true, indicates that the document being updated is a hyperlink (URL) rather than a file. Default is false.default false
x-resolvedboolean
When false, reference/lookup properties in the response are returned as raw objects (with _id and _es) instead of resolved display values. Default is true.default true
dynamo_upsert_documentCreate or update a document in Dynamo using key columns via PUT operation.Write
Upsert Document
Create or update a document in Dynamo using key columns via PUT operation.
Inputs
titlestringrequired
The display title of the document. Required for all document types (file or hyperlink).
contentstring
The document file contents encoded as a base64 string. Required when x_ishyperlink is false. Maps to '_content' in the API body.
extensionstring
The file extension including the dot prefix. Required when x_ishyperlink is false.
hyperlinkstring
The URL for a hyperlink document. Required when x_ishyperlink is true. Must be a valid URL.
x_identifierboolean
When true, the response includes the Identifier property (Name (ID)) for the document. Default is true.
x_importactionstring
Controls the create/update behavior when x_keycolumns is provided. Default is 'updateorcreate'.one of createupdateupdateorcreatedefault updateorcreate
x_ishyperlinkboolean
When true, the document is created/updated as a web hyperlink instead of a file upload. Default is false.default false
x_keycolumnsstring
Comma-separated column names used to determine the identity of a specific document for upsert matching. The '_content' column cannot be used as a key column.
x_keycolumns_encodedboolean
When true, the x_keycolumns value must be provided as a base64-encoded string. Default is false.default false
x_resolvedboolean
When false, reference/lookup properties in the response are returned as raw objects (with _id and _es) instead of resolved display values. Default is true.default true
dynamo_view_sql_sp_executeExecutes a SQL stored procedure in Dynamo and returns the result.Write
Execute SQL Stored Procedure
Executes a SQL stored procedure in Dynamo and returns the result.
Inputs
spNamestringrequired
The name of the SQL stored procedure to execute, without the 'EXPORTSQLSP_' prefix. The API prepends this prefix automatically when calling POST /api/v2.2/View/sql/EXPORTSQLSP_{spName}.
parametersobject
Optional JSON object containing named parameters to pass to the stored procedure. The object's keys and values depend on the specific stored procedure's parameter requirements.
dynamo_workflow_action_buttonTriggers a workflow action button operation on a specific entity record in Dynamo.Write
Trigger Workflow Action Button
Triggers a workflow action button operation on a specific entity record in Dynamo.
Inputs
entitystringrequired
The display name of the Dynamo entity type that contains the action button. Must match the entity name as configured in Dynamo.
entity_keystringrequired
The UUID of the specific entity record on which the action button workflow will be triggered.
propertystringrequired
The name of the action button property on the entity that maps to the workflow to trigger.
dynamo_workflow_custom_operationTriggers a custom workflow operation in Dynamo by operation name with optional parameters.Write
Trigger Workflow Custom Operation
Triggers a custom workflow operation in Dynamo by operation name with optional parameters.
Inputs
operationstringrequired
The name of the custom workflow operation to trigger. Used as the last segment of the URL: POST /api/v2.2/Workflow/CustomOperation/{operation}.
parametersobject
Optional JSON object containing named parameters to pass to the custom workflow operation. The keys and values depend on what the specific operation expects.
dynamo_workflow_scheduleTriggers all workflows defined to run on a specific schedule by schedule ID in Dynamo.Write
Trigger Workflow Schedule
Triggers all workflows defined to run on a specific schedule by schedule ID in Dynamo.
Inputs
idstringrequired
The UUID of the Dynamo workflow schedule to trigger. All workflows associated with this schedule will be executed immediately, as if the schedule's configured time had been reached.
dynamo_bulk_deleteDelete multiple entities in Dynamo Software using bulk import.Destructive
Bulk Delete Entities
Delete multiple entities in Dynamo Software using bulk import.
- Idempotent
Inputs
entityNamestringrequired
The name of the Dynamo entity whose records will be deleted (e.g., 'contact', 'activity').
itemsarrayrequired
A required array of entity objects to delete. Each object should contain '_id' or the internal ID property for the entity.
dynamo_delete_documentDeletes a single Dynamo document by ID.Destructive
Delete Document
Deletes a single Dynamo document by ID. This is a convenience shortcut for the generic Entity delete endpoint with the entity name fixed to 'Document'.
- Idempotent
Inputs
idstringrequired
The unique identifier (UUID) of the document to delete.
dynamo_entity_deleteDeletes a single instance of the specified Dynamo entity by ID.Destructive
Delete Entity
Deletes a single instance of the specified Dynamo entity by ID.
- Idempotent
Inputs
entityNamestringrequired
The name of the Dynamo entity type from which to delete the record (e.g., 'activity', 'contact').
idstringrequired
The unique identifier (UUID) of the specific entity record to delete.

What you can do

Setup

Install the SDK

Set your credentials

Create the Dynamo Software connection

Authorize a user and make your first call

Tools

Call it

Returns

Decrypt Entity Property

Inputs

Get Entity By ID

Inputs

Get Extended Entity Schema

Inputs

Get Entity Properties

Inputs

Get Entity Schema

Inputs

Get Entity Total Count

Inputs

Get Document By ID

Inputs

Get Document Extended Schema

Inputs

Get Document Properties

Inputs

Get Document Schema

Inputs

Get Document Upload Restrictions

Inputs

Get Documents

Inputs

Get Documents Total Count

Inputs

Get All Entities

Inputs

Get Entity Items

Inputs

Get Entity Schema

Inputs

Search Entities

Inputs

Get Views

Inputs

Search View

Inputs

Get SQL Views

Inputs

Get SQL View By Name

Inputs

Bulk Upsert Entities

Inputs

Create Document

Inputs

Upsert Entity Item

Inputs

Update Entity By ID

Inputs

Create Entity Item

Inputs

Reset API Key Cache

Inputs

Update Document By ID

Inputs

Upsert Document

Inputs

Execute SQL Stored Procedure

Inputs

Trigger Workflow Action Button

Inputs

Trigger Workflow Custom Operation

Inputs

Trigger Workflow Schedule

Inputs

Bulk Delete Entities

Inputs

Delete Document

Inputs

Delete Entity