Skip to main content

Create a SmartConnect Function

Updated

SmartConnect functions are specific to individual copies of SmartSimple. Only functions previously established in that copy of SmartSimple are available for use.

Who: SmartConnect functions are for Global User Administrators.

Create a SmartConnect Function

Global User Administrator permissions are required to add JSON functions. To create a new SmartConnect function:

  1. Log into the SmartSimple instance where you want to add the function.
  2. Click the System Administration gear in the upper navigation bar, and then select Global Settings from the drop-down menu.
  3. Click the Integrations tab.
  4. Click SmartConnect API. Existing functions are listed here and available to update.
  5. Click the New SmartConnect API [+] button to create a new function.

↑ Back to top

Function Settings

Each function includes the following settings:

Function Name — The name used to call the function from your code.

Description — The function's purpose.

Object Type — A list of all SmartSimple objects within the instance. This includes Report (reports created in the instance), Organization (company records), Users (system users and contacts), transactions, role, system variables, data receivers, and each UTA/module Level 1, Level 2, and Level 3 type created in the instance.

Action Type — Defines the action the function takes. Available actions for Company, User, and UTA/module options include: Delete, Get, Get Meta, List, Update, Associations - List, Associations - Update, Files - Delete, Files - Download, Files - List, Files - Search, Files - Upload, Multiple Addresses - List, Multiple Addresses - Update, Notes - List, and Variables Replace. 

  • The UTA/module Level 1 and Level 2 object type includes the Provider/Consumer - List and Provider/Consumer - Update actions. 
  • The Company Transactions and User Transactions object type includes an additional Link/Unlink action.
  • The Report object type includes the Report - Query action.
  • The Roles object type includes the Get Meta action.
  • The System Variables object type includes the Get, List, and Update actions.

When the Action Type is set to Update, the following additional fields appear:

  • Enable Input Filtering — Applies input filtering for field values to prevent cross-site scripting.
  • Disable Field Change History — Fields updated by this API call are not included in the field change history log.
  • Defer Post Update Process — Runs post-update processes such as template formula and workflow asynchronously to improve performance.
  • Run in Background — Queues records to run in the background to improve performance.
  • Bypass Field Type Validation — Allows updates to certain problematic field types.

For details on each action type and sample configurations, see SmartConnect Function Action Type Configurations.

Field List — Defines which fields are retrievable through the function call. Limit the field list to approximately 50 standard or custom fields.

Allow Access — Select the user roles that can access this function.

Return Key Format — Three options are available: As Inputted, Custom Field Name, and Custom Field ID.

Numeric Data Format — Two options are available: Raw Numeric Value and Formatted Numeric Value.

API Token — Displays the token after the function is saved.

Required Parameters — Lists any required parameters after the function is saved.

Optional Parameters — Lists any optional parameters after the function is saved.

Created By / Date — Details when the function was created.

Modified By / Date — Details the last saved change.

↑ Back to top

Test Your Configuration

Visit the interactive demonstration page to test sample functions.

↑ Back to top

Helpful Links