> Portal Navigation: > > - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version. > - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages). > - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # GetTrigger # Package: triggers # Namespace: TriggerCatalogService # Method link: https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-catalog/get-trigger.md ## Permission Scopes: Set Up Automations: SCOPE.CRM.SETUP-AUTOMATIONS ## Introduction Retrieves a trigger by ID (changes per component version). To get trigger by appId + triggerKey in context of a specific site, see [GetTriggerByAppIdAndKey](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-catalog/get-trigger-by-app-id-and-key.md). --- ## REST API ### Schema ``` Method: getTrigger Description: Retrieves a trigger by GUID (changes per component version). To get trigger by appId + triggerKey in context of a specific site, see [GetTriggerByAppIdAndKey](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-catalog/get-trigger-by-app-id-and-key.md). URL: https://www.wixapis.com/automations/triggercatalog/v1/trigger/{triggerId} Method: GET # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: triggerId Method parameters: param name: triggerId | type: none | required: true Return type: GetTriggerResponse - name: trigger | type: Trigger | description: Retrieved trigger. - name: id | type: string | description: Trigger GUID. (per component version) | validation: format GUID - name: appId | type: string | description: GUID of the [app that created the trigger](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/add-a-trigger-to-your-app.md). | validation: format GUID, immutable - name: triggerKey | type: string | description: Trigger key. Learn about [setting up a trigger](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/add-a-trigger-to-your-app.md#step-1--set-up-the-trigger). | validation: minLength 1, maxLength 100, immutable - name: payloadDataSchema | type: object | description: Trigger [payload schema](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/the-trigger-payload-schema.md). | validation: immutable - name: displayName | type: string | description: Trigger display name. Users see this name when they [choose a trigger for an automation](https://support.wix.com/en/article/wix-automations-creating-an-automation-with-the-new-builder#step-2-choose-a-trigger). | validation: minLength 5, maxLength 80 - name: filters | type: array | description: [Filter fields](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/about-triggers.md#filter-fields) applied to the trigger payload schema. | validation: maxItems 5 - ONE-OF: - name: staticFieldKey | type: string | description: The static field key. - name: dynamicFieldKey | type: DynamicFieldKey | description: Dynamic field key data. - name: label | type: string | description: Field key label. - name: description | type: string | description: Field key description. - name: entitySelector | type: EntitySelector | description: Selects the entity to be used as a dynamic field key. - name: id | type: string | description: Entity selector GUID. - name: queryFieldToFilterIdMapping | type: object | description: Mapping of the entity selector query fields to filter GUIDs. For example, let's say the Workflows `Card moved` trigger has 2 filters: - Select a workflow, with filter GUID `466d2067-05bd-44f9-99c7-d029b93e4feb`. - Select a step, with filter GUID `b45f8475-bd44-4971-8820-7031ee12a708`. The step entity selector requires the workflow GUID as input in order to return the list of relevant steps. We can map the `workflowId` field to the workflow filter in `queryFieldToFilterIdMapping`. When the Wix user selects a workflow in the workflow filter in the automation builder, Wix passes the selected workflow's GUID in the `workflowId` field to the step entity selector. The step filter then shows the relevant steps of the selected workflow for the user to select. | validation: format map - name: multiSelect | type: boolean | description: Whether a Wix user can select multiple items. Default: `false` - name: queryFieldToValueMapping | type: object | description: Mapping of the entity selector query fields to predefined values. This is useful when using the same entity selector in different triggers. For example: Let's say the `RSVPed to event` trigger has one filter, `Select a specific event`. This filter has an GUID `e91733fc-81b7-45ca-b50c-f0c292a23af5`. The events entity selector has a query field of `eventType`, that should be passed in order to return the list of relevant events. Otherwise, all events will be returned regardless of type. Map the `eventType` field to `RSVP`. When the Wix user selects an event in the event filter in the automation builder, the client shows only `RSVP` events in the selection options because the `eventType` field was set to `RSVP`. | validation: format map - name: id | type: string | description: Filter GUID. | validation: format GUID - name: fieldKeyType | type: FieldKeyType | description: Field key type. - enum: - UNKNOWN_FIELD_KEY_TYPE: The field key type is unknown. - STATIC_FIELD_KEY: The field key is a static value. - DYNAMIC_FIELD_KEY: The field key changes depending on the filter selection. - name: valueInput | type: ValueInput | description: Input field metadata. - ONE-OF: - name: entitySelector | type: EntitySelector | description: Entity selector details. - name: userInput | type: UserInput | description: User input details. - ONE-OF: - name: numberInputOptions | type: NumberInputOptions | description: Options for user input of type `number`. - name: defaultValue | type: integer | description: Default number value. | validation: format int32 - name: minValue | type: integer | description: Minimum number value. | validation: format int32 - name: maxValue | type: integer | description: Maximum number value. | validation: format int32 - name: booleanInputOptions | type: BooleanInputOptions | description: Options for user input of type `boolean`. - name: defaultValue | type: boolean | description: Default boolean value. - name: type | type: Type | description: User input type. - enum: - UNKNOWN_USER_INPUT: Unknown input type. - NUMBER: Number input type. - BOOLEAN: Boolean input type. - name: staticItems | type: StaticItems | description: Static value details. - name: multiSelect | type: boolean | description: Whether the Wix user can select multiple items Default: `false`. - name: staticValues | type: array | description: Static list of values for the Wix user to select. The value is saved on the automation-level trigger filter, and shown to Wix users at setup time if `displayName` is missing. `displayName` is optionally shown to users to help select a value. - name: id | type: string | description: item identifier | validation: format GUID - name: value | type: string | description: static value - name: displayName | type: string | description: optional displayName for the value - name: type | type: Type | description: Input value type. - enum: - UNKNOWN_VALUE_INPUT: Unknown filter field input. - ENTITY_SELECTOR: Filter field input is a selection of one from multiple entities, such as a form. - USER_INPUT: Filter field value is input from a Wix user. - STATIC_ITEMS: Filter field value is a static value defined in the payload schema. - name: label | type: string | description: Input field label. - name: description | type: string | description: Input field description. May be used for a tooltip. - name: required | type: boolean | description: Whether the Wix user is required to enter a value in the field. Default: `false` - name: reevaluateDynamicSchema | type: boolean | description: Whether Wix should reevaluate the dynamic schema when the field value changes. Default: `false` - name: followUpFilters | type: array | description: Filters to display after first selection is made. | validation: maxItems 5 - name: implementedMethods | type: ImplementedMethods | description: Additional [service plugin methods](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/introduction.md#implement-the-service-plugin-methods) implemented for this trigger. - name: validateConfiguration | type: boolean | description: Whether [Validate Configuration](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/validate-configuration.md) is implemented. Default: `false`. - name: getDynamicSchema | type: boolean | description: Whether [Get Dynamic Schema](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/get-dynamic-schema.md) is implemented. Default: `false`. - name: refreshPayload | type: boolean | description: Whether [Refresh Payload](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/refresh-payload.md) is implemented. Default: `false`. - name: createdDate | type: string | description: Date and time the trigger was created. | validation: format date-time - name: updatedDate | type: string | description: Date and time the trigger was last updated. | validation: format date-time - name: baseUri | type: string | description: Trigger base URI. Wix calls your trigger at this base address. Learn more about the [Wix Automations Trigger Provider service plugin](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/introduction.md). | validation: maxLength 256 ``` ### Examples ### Get Trigger ```curl curl -X GET "https://www.wixapis.com/v1/trigger/2315a306-a2f6-4c3e-ac52-08da7c552f2b" \ -H "Authorization: " \ -H "Content-Type:application/json" ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.automations.triggerCatalog.getTrigger(triggerId) Description: Retrieves a trigger by GUID (changes per component version). To get trigger by appId + triggerKey in context of a specific site, see [GetTriggerByAppIdAndKey](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-catalog/get-trigger-by-app-id-and-key.md). # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: triggerId Method parameters: param name: triggerId | type: string | description: GUID of the trigger to retrieve. | required: true | validation: format GUID Return type: PROMISE - name: _id | type: string | description: Trigger GUID. (per component version) | validation: format GUID - name: appId | type: string | description: GUID of the [app that created the trigger](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/add-a-trigger-to-your-app.md). | validation: format GUID, immutable - name: triggerKey | type: string | description: Trigger key. Learn about [setting up a trigger](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/add-a-trigger-to-your-app.md#step-1--set-up-the-trigger). | validation: minLength 1, maxLength 100, immutable - name: payloadDataSchema | type: object | description: Trigger [payload schema](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/the-trigger-payload-schema.md). | validation: immutable - name: displayName | type: string | description: Trigger display name. Users see this name when they [choose a trigger for an automation](https://support.wix.com/en/article/wix-automations-creating-an-automation-with-the-new-builder#step-2-choose-a-trigger). | validation: minLength 5, maxLength 80 - name: filters | type: array | description: [Filter fields](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/about-triggers.md#filter-fields) applied to the trigger payload schema. | validation: maxItems 5 - ONE-OF: - name: staticFieldKey | type: string | description: The static field key. - name: dynamicFieldKey | type: DynamicFieldKey | description: Dynamic field key data. - name: label | type: string | description: Field key label. - name: description | type: string | description: Field key description. - name: entitySelector | type: EntitySelector | description: Selects the entity to be used as a dynamic field key. - name: _id | type: string | description: Entity selector GUID. - name: queryFieldToFilterIdMapping | type: object | description: Mapping of the entity selector query fields to filter GUIDs. For example, let's say the Workflows `Card moved` trigger has 2 filters: - Select a workflow, with filter GUID `466d2067-05bd-44f9-99c7-d029b93e4feb`. - Select a step, with filter GUID `b45f8475-bd44-4971-8820-7031ee12a708`. The step entity selector requires the workflow GUID as input in order to return the list of relevant steps. We can map the `workflowId` field to the workflow filter in `queryFieldToFilterIdMapping`. When the Wix user selects a workflow in the workflow filter in the automation builder, Wix passes the selected workflow's GUID in the `workflowId` field to the step entity selector. The step filter then shows the relevant steps of the selected workflow for the user to select. | validation: format map - name: multiSelect | type: boolean | description: Whether a Wix user can select multiple items. Default: `false` - name: queryFieldToValueMapping | type: object | description: Mapping of the entity selector query fields to predefined values. This is useful when using the same entity selector in different triggers. For example: Let's say the `RSVPed to event` trigger has one filter, `Select a specific event`. This filter has an GUID `e91733fc-81b7-45ca-b50c-f0c292a23af5`. The events entity selector has a query field of `eventType`, that should be passed in order to return the list of relevant events. Otherwise, all events will be returned regardless of type. Map the `eventType` field to `RSVP`. When the Wix user selects an event in the event filter in the automation builder, the client shows only `RSVP` events in the selection options because the `eventType` field was set to `RSVP`. | validation: format map - name: _id | type: string | description: Filter GUID. | validation: format GUID - name: fieldKeyType | type: FieldKeyType | description: Field key type. - enum: - UNKNOWN_FIELD_KEY_TYPE: The field key type is unknown. - STATIC_FIELD_KEY: The field key is a static value. - DYNAMIC_FIELD_KEY: The field key changes depending on the filter selection. - name: valueInput | type: ValueInput | description: Input field metadata. - ONE-OF: - name: entitySelector | type: EntitySelector | description: Entity selector details. - name: userInput | type: UserInput | description: User input details. - ONE-OF: - name: numberInputOptions | type: NumberInputOptions | description: Options for user input of type `number`. - name: defaultValue | type: integer | description: Default number value. | validation: format int32 - name: minValue | type: integer | description: Minimum number value. | validation: format int32 - name: maxValue | type: integer | description: Maximum number value. | validation: format int32 - name: booleanInputOptions | type: BooleanInputOptions | description: Options for user input of type `boolean`. - name: defaultValue | type: boolean | description: Default boolean value. - name: type | type: Type | description: User input type. - enum: - UNKNOWN_USER_INPUT: Unknown input type. - NUMBER: Number input type. - BOOLEAN: Boolean input type. - name: staticItems | type: StaticItems | description: Static value details. - name: multiSelect | type: boolean | description: Whether the Wix user can select multiple items Default: `false`. - name: staticValues | type: array | description: Static list of values for the Wix user to select. The value is saved on the automation-level trigger filter, and shown to Wix users at setup time if `displayName` is missing. `displayName` is optionally shown to users to help select a value. - name: _id | type: string | description: item identifier | validation: format GUID - name: value | type: string | description: static value - name: displayName | type: string | description: optional displayName for the value - name: type | type: Type | description: Input value type. - enum: - UNKNOWN_VALUE_INPUT: Unknown filter field input. - ENTITY_SELECTOR: Filter field input is a selection of one from multiple entities, such as a form. - USER_INPUT: Filter field value is input from a Wix user. - STATIC_ITEMS: Filter field value is a static value defined in the payload schema. - name: label | type: string | description: Input field label. - name: description | type: string | description: Input field description. May be used for a tooltip. - name: required | type: boolean | description: Whether the Wix user is required to enter a value in the field. Default: `false` - name: reevaluateDynamicSchema | type: boolean | description: Whether Wix should reevaluate the dynamic schema when the field value changes. Default: `false` - name: followUpFilters | type: array | description: Filters to display after first selection is made. | validation: maxItems 5 - name: implementedMethods | type: ImplementedMethods | description: Additional [service plugin methods](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/introduction.md#implement-the-service-plugin-methods) implemented for this trigger. - name: validateConfiguration | type: boolean | description: Whether [Validate Configuration](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/validate-configuration.md) is implemented. Default: `false`. - name: getDynamicSchema | type: boolean | description: Whether [Get Dynamic Schema](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/get-dynamic-schema.md) is implemented. Default: `false`. - name: refreshPayload | type: boolean | description: Whether [Refresh Payload](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/refresh-payload.md) is implemented. Default: `false`. - name: _createdDate | type: Date | description: Date and time the trigger was created. - name: _updatedDate | type: Date | description: Date and time the trigger was last updated. - name: baseUri | type: string | description: Trigger base URI. Wix calls your trigger at this base address. Learn more about the [Wix Automations Trigger Provider service plugin](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/introduction.md). | validation: maxLength 256 ``` ### Examples ### Get a trigger by ID ```javascript import { triggerCatalog } from "@wix/automations"; const triggerId = "2315a306-a2f6-4c3e-ac52-08da7c552f2b"; async function getTrigger() { const response = await triggerCatalog.getTrigger(triggerId); return response; } /* Promise resolves to: * { * "trigger": { * "appId": "c721a744-80ea-4305-b0b2-00af08d3a6ed", * "triggerKey": "wix_e_commerce-order_placed", * "payloadDataSchema": { * "$schema": "http://json-schema.org/draft-07/schema", * "type": "object", * "properties": { * "orderNumber": { "type": "string", "title": "Order number" }, * "currency": { "type": "string", "title": "Currency" }, * "createdDate": { "type": "string", "format": "date-time", "title": "Date created" } * }, * "required": ["orderNumber", "currency", "createdDate"] * }, * "displayName": "Order placed", * "filters": [], * "implementedMethods": { * "validateConfiguration": false, * "getDynamicSchema": false, * "refreshPayload": false * }, * "_id": "2315a306-a2f6-4c3e-ac52-08da7c552f2b", * "_createdDate": "2024-01-15T10:30:00.000Z", * "_updatedDate": "2024-01-15T10:30:00.000Z" * } * } */ ``` ### getTrigger (self-hosted) Self-hosted SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md). ```javascript import { createClient } from '@wix/sdk'; import { triggerCatalog } from '@wix/automations'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { triggerCatalog }, // Include the auth strategy and host as relevant }); async function getTrigger(triggerId) { const response = await myWixClient.triggerCatalog.getTrigger(triggerId); }; ``` ---