Marketplace Workflow Actions

Modified on: Mon, 23 Sep, 2024 at 5:30 AM

Marketplace Workflow Actions are the customizable workflow actions managed in Marketplace. You will be able to create custom actions to push or pull data from your application/API in a workflow using customized fields and API endpoint.

Sign up/ Sign in to Marketplace to manage Marketplace Workflow Actions.

Marketplace Workflow Actions are part of LC Premium Triggers & Actions and are chargeable per execution.

How to enable and rebill LC Premium Triggers & Actions for Workflows?

You should enable Workflow LC Premium Triggers & Actions for the sub-account to access the Actions created in the Marketplace App.

The marketplace workflow actions created in an APP will be listed in the workflow actions only if the sub-account has the APP installed/integrated from the Marketplace.

TABLE OF CONTENTS

Prerequisites
Create Action
- Name
- Action Information
Action Configuration
- Manage Fields
Multi-branch
Action Execution
Pause Execution
Manage Custom Variables
Add Custom Variable
Submit for Review
Create New Version
Delete Action

Prerequisites

Note : workflows.readyonly scope should be turned on to enable actions and triggers.

Create Action

Name

Enter Action Name

Key

A unique identifier for this action, used to reference the action inside the workflow. This value cannot be changed later. Example: {{mycustomaction.data.name}}

Action Information

Add action details

Icon

Choose an Icon for this Action. Shown in workflow for this action.

Name

Custom Action Name

Key

A unique identifier for this action, used to reference the action inside the workflow, Ex: {{action_a.custom_variable}}. This value cannot be changed later.

Short description

A short description explaining what your action does to help users understand. Shown in workflow as sub-title for this action.

Summary

A detailed information on what your action does to help users understand why they should use this action.

Action Configuration

Manage Fields

Construct form to collect the data required for sending to API

Create New Field

Name

Enter Field Name

Type

Select one of the following field types:

String
Numerical
Textarea
Select
Multiple Select
Radio
Toggle
Checkbox
Attachment
Rich Text Editor
Hidden
Dynamic

Required

Enable if this is a required field in workflow.

Reference

Enter unique reference key. The value of this field will be bind to the provided key. Example: action_a_name

Default Value

Enter or map a value. The value provided will be used as default value for this field when loaded in workflow.

Alters Dynamic Field

If enabled, any changes made to this field value will trigger/ re-trigger loading the dynamic fields to the workflow action configuration UI.

Type: Select / Multi Select / Radio

Option Type is applicable only for Select, Multi Select and Radio field types.

Select one of the following option types:

Constants
Internal Reference
External API

Constants

Load options by adding custom Label-Value constants

Internal Reference

Load options from HighLevel Internal Modules. Select one of the HighLevel Modules to load options list.

Supported HighLevel Modules

External API

Load option from external API endpoint

URL (GET)

Provide a URL to support GET method and send a valid response as per the sample response structure shared below.

Headers

Add headers as per your requirement

Sample Response Data

{
   "options": [
      {
         "label": "Afghanistan",
         "value": "AF"
      },
      {
         "label": "Åland Islands",
         "value": "AX"
      },
      {
         "label": "Albania",
         "value": "AL"
      },
      {
         "label": "Algeria",
         "value": "DZ"
      },
      {
         "label": "American Samoa",
         "value": "AS"
      }
   ]
}

Type: Hidden

It will be hidden in the action configuration and the mapped data will be sent in the payload. Used to collect essential information such as company_id, customerid, etc,. from system data or from your custom triggers

Type: Dynamic

Dynamic fields are used to build custom fields from an API call. The API call should return the below response structure to construct the fields in the Workflow action configuration form UI. Only one Dynamic type can be created per action.

URL (POST)

Enter your API endpoint URL. When executed data is sent to this API endpoint via POST method in the below mentioned payload format and a valid response is expected as per the sample response structure shared below.

Headers

Add headers as per your requirement

Sample Payload:
The form data is sent as payload to the dynamic field API

{
   "data": {
        "name": "John Doe",
        "age": "29",
        "gender": "male",
        "hobbies": ["sports", "music"],
        "address": "My Address",
        "country": "US",
        "profileType": "public",
        "dataShare": true,
        "tems": true,
   },
   "extras": {
        "locationId": "xyz",
        "contactId": "abc",
        "workflowId": "def"
   },
   "meta": {
        "key": "custom_action_key",
        "version": "1.0",
   }
}

Sample Response Structure:
Sections are used to group the fields in UI

{
   "inputs": [
      {
         "section": "Personal Info",
         "fields": [
            {
               "field": "name",
               "title": "Name",
               "fieldType": "string",
               "required": true
            },
            {
               "field": "age",
               "title": "Age",
               "fieldType": "numerical",
               "required": true
            },
            {
               "field": "gender",
               "title": "Gender",
               "fieldType": "select",
               "required": true,
               "options": [
                  {
                     "label": "Male",
                     "value": "male"
                  },
                  {
                     "label": "Female",
                     "value": "female"
                  }
               ]
            }
         ]
      },
      {
         "section": "Location Info",
         "fields": [
            {
               "field": "village",
               "title": "Village",
               "fieldType": "string",
               "required": true
            },
            {
               "field": "city",
               "title": "City",
               "fieldType": "string",
               "required": true
            },
            {
               "field": "fullAddress",
               "title": "Your Full Address",
               "fieldType": "textarea",
               "required": true
            }
         ]
      }
   ]
}

Sample structure for each Field Types

String

{
   "field": "name",
   "title": "Name",
   "fieldType": "string",
   "required": true
}

Numeric

{
   "field": "name",
   "title": "Name",
   "fieldType": "numeric",
   "required": true
}

Textarea

{
  "field": "description",
  "title": "Description",
  "fieldType": "textarea",
  "required": true
}

Select

{
   "field": "gender",
   "title": "Gender",
   "fieldType": "select",
   "required": true,
   "options": [
      {
         "label": "Male",
         "value": "male"
      },
      {
         "label": "Female",
         "value": "female"
      }
   ]
}

Multiple Select

{
   "field": "hobbies",
   "title": "Hobbies",
   "fieldType": "multiselect",
   "required": true,
   "options": [
      {
         "label": "Sport",
         "value": "sport"
      },
      {
         "label": "Music",
         "value": "music"
      }
   ]
}

Radio

{
  "field": "profileType",
  "title": "Profile Type",
  "fieldType": "radio",
  "required": true,
  "options": [
      {
          "label": "Public",
          "value": "public"
      },
      {
          "label": "Private",
          "value": "private"
      }
  ]
}

Toggle

{
  "field": "dataShare",
  "title": "Allow my data to be stored",
  "fieldType": "toggle",
  "required": true
}

Checkbox

{
  "field": "terms",
  "title": "Terms & conditions",
  "fieldType": "checkbox",
  "required": true
}

Multi-branch

The Multi-Branch Feature enables the creation of branches that can dynamically adjust based on various predefined conditions. By allowing multiple branches within a workflow each contact can directed down the appropriate path based on their interactions or status.

Branch Section: Defines the name or identifier for the specific branch section.
Branch Section Description: Provides a brief description or details about the branch section.
Branch Name Label: Specifies the label that will be displayed for the branch name.
Branch Name Helptext: Offers additional information related to the branch name.
Delete Branch Title: Sets the title or label used when deleting a branch.
Delete Branch Description: Describes when a branch is deleted.

Allow New Branches: Enables users to add new branches within the action.
Is Predefined Branches Editable: Allows users to edit predefined branches within the action.

Show Branches Section: Displays the branch section details to the user.

Disabled Allow new branch

Pre-defined branch is editable

Hide branch

Sample payload for branches

{
  "data": {
    "name": "John Doe",
    "age": "29",
    "gender": "male",
    "hobbies": [
      "sports",
      "music"
    ],
    "address": "My Address",
    "country": "US",
    "profileType": "public",
    "dataShare": true,
    "tems": true,
    "branches": [
      {
        "id": "a8d14b13-d7cc-4241-bd2c-53180f0ec278",
        "name": "Branch name",
        "fields": {
          "branchFieldKey": "branchFieldValue"
        }
      }
    ]
  },
  "extras": {
    "locationId": "xyz",
    "contactId": "abc",
    "workflowId": "def"
  },
  "meta": {
    "key": "custom_action_key",
    "version": "1.0"
  }
}

Action Execution

Allows you to choose between an API or a custom code.

API

URL (POST)

Enter your API endpoint URL. When this action is executed data is sent to this API endpoint via POST method in the below mentioned payload format.

Headers

Add required header data that has to be included while sending data to the API endpoint

Sample Payload:
The form data is sent as payload to the Send Data URL

{
   "data": {
        "name": "John Doe",
        "age": "29",
        "gender": "male",
        "hobbies": ["sports", "music"],
        "address": "My Address",
        "country": "US",
        "profileType": "public",
        "dataShare": true,
        "tems": true,
   },
   "extras": {
        "locationId": "xyz",
        "contactId": "abc",
        "workflowId": "def"
   },
   "meta": {
        "key": "custom_action_key",
        "version": "1.0",
   }
}

Custom code

Custom Code allows users to create custom logic they want to achieve. This provides flexibility and control beyond the pre-built APIs, enabling users to automate complex tasks and integrate with various services not supported by API.

Code Editor

You can write the code in the Code Editor

You can input HTTP requests like Get, Put, Post, Delete etc via the button.

You can also use cutom values using the picker.

Output should be a JavaScript Object or Array of Objects.

Test and format your Code

Testing the code is a mandatory step, if the test is not done then user will not be able to use the output of the code in the subsequent steps.
To test the code click on the "Test Code" button.
Post clicking on Run test button, if there are no errors in the code them it will show "Test Result Success" and if there is an error in code then the result will be "Test Result Failed" and you would have to recheck the code to remove the error.
You can also format the code using "Format code" button.

Pause Execution

This toggle is used the contact will be held at this action unless resume webhook is requested.
If this toggle is true then provided extras object needs to be pass as body payload for resume workflow endpoint.
Show API details button shows a sample response to be passed onto to the webhook for Success Execution and Failed Execution.

In case of Sync Execution

When the pause execution is turned off along with branching support, the contact will be moved to provided branch using `branchId` property from API response or from Custom Code using return statement. The branchId here will be the branch through with the contact will move forward.

In case of Async Execution

When the pause execution is turned off, the branch ID needs to be sent to the webhook for resuming which is present in "show API details" button. More info present in Pause functionality.

Response Data

Add sample response data to configure custom variables.

Add sample response

Enter a valid sample response JSON structure that will be sent as a response to the Send Data API endpoint.

Arrays are supported in response data. This data can be utilized in custom variables based on references and is available for use in Array Functions, Custom Code, and Custom Webhooks.

A new dropdown option allows users to select between a standard value or a custom value picker.

Standard Values: Users can input data based on the field type (e.g., date, dropdown, tag).
Custom Value Picker: Users can input data from custom fields, such as values from an inbound webhook trigger or other custom fields.

Manage Custom Variables

Add Custom variables using sample response data, for users to use in workflows

Add Custom Variable

Name

Enter label name

Reference

Select a reference key from the sample response saved to Response Data.

Submit for Review

The action version will be in draft state by default. After updating the action information and configuration the action version should be submitted for review.

Click on Submit for review and add required changelog information for the submitted version.

Once approved the version submitted for review will be published live to all Sub-accounts.

Create New Version

Click on + New Version to create a new version for the action

On clicking + New Version It will create a new draft version with all the previously published data prefilled.

Delete Action

Once an Action is deleted, it will be deleted permanently and cannot be restored. The deleted action will be removed from Marketplace App and Workflow Action list. If a deleted action is part of any workflow the action execution will be skipped.

Enter action name to confirm delete