Marketplace Workflow Triggers

Marketplace Workflow Triggers allow you to create custom triggers that push data from your external applications or APIs directly into your CRM workflows. These triggers are managed through the Marketplace interface and are part of the premium triggers and actions package, which requires a subscription and incurs charges per execution.

Prerequisites

Before you can use Marketplace Workflow Triggers, you must ensure that the workflows.readyonly scope is enabled. Additionally, the sub-account where you want to use these triggers must have the relevant Marketplace app installed and the premium triggers and actions feature activated.

Creating a Trigger

To create a new trigger in the Marketplace:

  1. Navigate to the trigger creation section.
  2. Provide a Name for your trigger.
  3. Set a unique Key that will be used to reference the trigger within workflows. Note that this key cannot be changed after creation.

Trigger Information

In this section, you can customize how your trigger appears to users:

  • Icon: Select an icon that represents your trigger in the workflow builder.
  • Name: Set the display name for your trigger.
  • Key: The unique identifier used in workflows (e.g., {{trigger_a.custom_variable}}).
  • Short Description: Provide a brief explanation of what the trigger does.
  • Summary: Offer detailed information about the trigger's purpose and benefits.

Trigger Configuration

Trigger Data

Add sample payload data in JSON format that represents the data structure your trigger will send. This sample is used to configure filters and custom variables.

Manage Filters

Filters allow workflow users to refine when the trigger should execute based on specific conditions. You can create filters with the following properties:

  • Name: The filter's display name.
  • Type: Choose from String, Select, Multiple Select, or Dynamic field types.
  • Required: Mark if the filter must be configured in the workflow.
  • Reference: Link the filter to a specific key in your sample trigger data.
  • Alters Dynamic Filter: If enabled, changes to this filter will reload dynamic filters in the workflow UI.

For Select and Multiple Select types, you can define options through:

  • Constants: Manually add label-value pairs.
  • Internal Reference: Pull options from supported CRM modules.
  • External API: Fetch options from an external API endpoint that returns options in a specific JSON format.

Dynamic Filters

Dynamic filters build custom filter forms via an API call. Only one dynamic filter can be created per trigger. Your API should accept POST requests with a specific payload format and return filter definitions in the expected JSON structure.

Manage Custom Variables

Custom variables allow you to expose specific data points from your trigger payload for use in workflows. For each variable, specify a name and reference it to a key in your sample trigger data.

Subscription URL

Configure an API endpoint that will receive notifications when your trigger is created, updated, or deleted in a workflow. The CRM will send POST requests to this URL with details about the trigger configuration changes.

Trigger Execution Without Contact

Marketplace Workflow Triggers can execute workflows even when no specific contact is associated with the incoming data, making them suitable for system-level automation tasks.