Creating Custom Marketplace Workflow Actions

About Marketplace Workflow Actions

Marketplace Workflow Actions enable you to build custom integrations that push or pull data from external applications or APIs directly within your CRM workflows. These actions use customizable fields and API endpoints to extend your automation capabilities beyond built-in features.

Note: Marketplace Workflow Actions are part of the CRM Premium Triggers & Actions package, which requires a paid subscription and incurs charges per execution.

Prerequisites

Before creating Marketplace Workflow Actions, ensure:

• Your sub-account has the CRM Premium Triggers & Actions feature enabled and billed
• The workflows.readyonly scope is turned on to allow actions and triggers
• The relevant Marketplace app is installed/integrated in your sub-account

Creating a New Action

Action Information

Begin by providing basic details about your custom action:

• Action Name: Enter a descriptive name that identifies what your action does
• Key: Create a unique identifier used to reference this action within workflows (e.g., {{mycustomaction.data.name}}). This value cannot be changed once set
• Icon: Select an icon that will represent this action in workflow builders
• Short Description: Provide a brief explanation of what your action does (shown as a subtitle in workflows)
• Summary: Include detailed information about why users should use this action

Action Configuration

Build the form that collects data required for your API call:

Managing Fields

Create fields to gather necessary information from users when they configure your action in a workflow. For each field, configure:

• Name: The label users will see
• Type: Select from String, Numerical, Textarea, Select, Multiple Select, Radio, Toggle, Checkbox, Attachment, Rich Text Editor, Hidden, or Dynamic
• Required: Enable if users must provide a value for this field
• Reference: Enter a unique reference key that binds to this field's value
• Default Value: Set a predefined or mapped value that appears by default
• Alters Dynamic Field: Enable if changes to this field should trigger reloading of dynamic fields

Field Type Options

Depending on your field type selection, additional configuration options may appear:

Select/Multi Select/Radio Fields

For selection-based fields, choose how options are loaded:

• Constants: Manually add label-value pairs
• Internal Reference: Load options from CRM internal modules
• External API: Pull options from an external API endpoint using GET method

Hidden Fields

Use hidden fields to collect essential information (like company_id or customerid) from system data or custom triggers without displaying them in the configuration UI.

Dynamic Fields

Dynamic fields build custom field configurations from an API response. Only one dynamic field can be created per action. Configure:

• URL (POST): Your API endpoint that receives payload data and returns field configuration
• Headers: Add any required headers for your API call

Validation Rules

Set validation rules to ensure data quality by checking values before they're saved or passed downstream. If validation fails, the system blocks submission and shows your custom error message.

Action Execution

Configure how your action processes data:

• API: Define the endpoint URL, method, headers, and payload format for your main API call
• Custom Code: Write and test JavaScript code to handle API responses and data processing
• Pause Execution: Configure whether workflow execution should wait for your action to complete

Managing Custom Variables

Add custom variables to store and reference data from your action's execution throughout the workflow.

Finalizing Your Action

Once configured, submit your action for review. You can also create new versions or delete actions as needed.