Marketplace Workflow Triggers

Modified on: Fri, 16 Aug, 2024 at 2:19 AM

Marketplace Workflow Triggers are the customizable workflow triggers managed in Marketplace. You will be able to create custom triggers to push data from your application/API to a workflow.


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

Marketplace Workflow Triggers 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 Triggers created in the Marketplace App.

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


TABLE OF CONTENTS


Prerequisites

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


Create Trigger

Name

Enter Trigger Name


Key

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


Trigger Information

Add trigger details


Icon

Choose an Icon for this Trigger. Shown in workflow for this trigger.

Name

Custom Trigger Name

Key

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

Short description

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

Summary

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


Trigger Configuration

Trigger Data

Add sample trigger payload data to configure filters and custom variables.


Add sample trigger payload data

Enter a valid sample payload JSON structure that will be sent to the trigger.



Manage Filters

Add filters using sample trigger data, for users to use in workflows trigger configuration.


Create New Filter


Name

Enter Filter Name


Type

Select one of the following field types:

  • String
  • Select
  • Multiple Select
  • Dynamic


Required

Enable if this is a required filter in workflow.

Reference

Select reference key from the sample Trigger Data. The value of this field will be bind to the provided key. Example: trigger_a_name

Alters Dynamic Filter

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


Type: Select / Multi Select

Option Type is applicable only for Select and Multi Select 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: Dynamic

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


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",
},
"extras": {
"locationId": "xyz",
"contactId": "abc",
"workflowId": "def"
},
"meta": {
"key": "custom_trigger_key",
"version": "1.0",
}
}


Sample Response Structure: 

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


Sample structure for each Filter Types

String

{
"field": "name",
"title": "Name",
"fieldType": "string",
"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"
}
]
}

Manage Custom Variables

Add Custom variables using trigger data, for users to use in workflows.

Add Custom Variable

Name

Enter label name

Reference

Select a reference key from the sample trigger data.


Subscription URL

Collect trigger configuration details through API endpoint.


URL (POST)

Enter your API endpoint URL. When a trigger is configured (CREATED/UPDATED/DELETED) in workflow the trigger configuration 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


Payload format:

Trigger "CREATED" in workflow

{
"triggerData": {
"id": "def",
"key": "trigger_a",
"filters": [],
"eventType": "CREATED",
"targetUrl": "https://services.leadconnectorhq.com/workflows-marketplace/triggers/execute/abc/def"
},
"meta": {
"key": "trigger_a",
"version": "2.4"
},
"extras": {
"locationId": "ghj",
"workflowId": "qwe",
"companyId": "asd"
}
}


Trigger "UPDATED" in workflow

{
"triggerData": {
"id": "def",
"key": "trigger_a",
"filters": [
{
"field": "country",
"id": "country",
"operator": "==",
"title": "Country",
"type": "select",
"value": "USA"
}
],
"eventType": "UPDATED",
"targetUrl": "https://services.leadconnectorhq.com/workflows-marketplace/triggers/execute/abc/def"
},
"meta": {
"key": "trigger_a",
"version": "2.4"
},
"extras": {
"locationId": "ghj",
"workflowId": "qwe",
"companyId": "asd"
}
}


Trigger "UPDATED" in workflow

{
"triggerData": {
"id": "def",
"key": "trigger_a",
"filters": [
{
"field": "country",
"id": "country",
"operator": "==",
"title": "Country",
"type": "select",
"value": "USA"
}
],
"eventType": "DELETED",
"targetUrl": "https://services.leadconnectorhq.com/workflows-marketplace/triggers/execute/abc/def"
},
"meta": {
"key": "trigger_a",
"version": "2.4"
},
"extras": {
"locationId": "ghj",
"workflowId": "qwe",
"companyId": "asd"
}
}



Submit for Review

The trigger version will be in draft state by default. After updating the trigger information and configuration the trigger 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 trigger


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



Delete Trigger

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



Enter trigger name to confirm delete




Can workflow execute without contact?

  • Workflow can run contactless without any Contact data dependency so you can send any payload data via Marketplace Triggers and use it in workflow.
  • You can proceed without contact and use actions that are not dependent on contact information. Custom Webhook, Google Sheet, Slack, ChatGPT and all Internal Tools can be executed without contact.
  • If necessary, you can use the Create/Update or Find Contact actions to retrieve the contact data to the workflow.

    Example:
  • Send order data to trigger and add the order information to google sheet, use if/else to categorize based on order value and send a slack notification.
  • Retrieve the contact with Contact ID using Find contact action

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select at least one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article