> 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

# GetTriggerDynamicSchema

# Package: triggers

# Namespace: TriggerCatalogService

# Method link: https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-catalog/get-trigger-dynamic-schema.md

## Permission Scopes:
Set Up Automations: SCOPE.CRM.SETUP-AUTOMATIONS

## Introduction

Retrieves a trigger's payload schema with the user's [filter field](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/triggers/filter-fields.md) selections applied.

Learn more about [the trigger payload schema](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/the-trigger-payload-schema.md).

---

## REST API

### Schema

```
 Method: getTriggerDynamicSchema
 Description: Retrieves a trigger's payload schema with the user's [filter field](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/triggers/filter-fields.md) selections applied.  Learn more about [the trigger payload schema](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/the-trigger-payload-schema.md).
 URL: https://www.wixapis.com/v1/triggers/dynamic_schema
 Method: POST
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  appId, triggerKey
 Method parameters: 
   param name: appId | type: appId | 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). | required: true
   param name: selectedFilterOptions | type: array<selectedFilterOptions> | description: When the trigger includes [filter fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/triggers/filter-fields.md), the trigger schema only includes the schemas of the specified filter fields.  When empty, the full trigger's payload schema is returned. 
              - name: fieldKey | type: string | description: Key representing a field from the trigger's [payload schema](https://dev.wix.com/docs/rest/business-management/automations/triggers/the-trigger-payload-schema.md) that has been configured as an [item selection filter](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/triggers/filter-fields.md#item-selection). For example `formId`. 
              - name: values | type: array | description: Values selected for the filter field. 
   param name: triggerKey | type: triggerKey | description: Trigger key.  Learn more about [adding a trigger to your app](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/add-a-trigger-to-your-app.md). | required: true
 Return type: GetDynamicSchemaResponse
  - name: dynamicSchema | type: object | description: A [JSON schema](https://json-schema.org/) corresponding to the filter selection sent in the request. 


```

### Examples

### Get the dynamic schema of the specified trigger
```curl
curl -X POST 'https://www.wixapis.com/v1/triggers/dynamic_schema' \
    -H 'Authorization: <AUTH>' \
    -H 'Content-Type: application/json' \
    -d '{
      "appId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "triggerKey": "my_app-form_submitted",
      "selectedFilterOptions": [
        {
          "fieldKey": "formId",
          "values": ["contact-form", "newsletter-signup"]
        }
      ]
    }'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.triggers.TriggerCatalogService.getTriggerDynamicSchema(appId, options)
 Description: Retrieves a trigger's payload schema with the user's [filter field](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/triggers/filter-fields.md) selections applied.  Learn more about [the trigger payload schema](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/the-trigger-payload-schema.md).
 # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present.
 Required parameters:  appId, options.triggerKey, options
 Method parameters: 
   param 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). | required: true
   param name: options | type: GetTriggerDynamicSchemaOptions  none | required: true
        - name: triggerKey | type: string | description: Trigger key.  Learn more about [adding a trigger to your app](https://dev.wix.com/docs/api-reference/business-management/automations/triggers/add-a-trigger-to-your-app.md). | required: true
        - name: selectedFilterOptions | type: array<SelectedFilterOptions> | description: When the trigger includes [filter fields](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/triggers/filter-fields.md), the trigger schema only includes the schemas of the specified filter fields.  When empty, the full trigger's payload schema is returned. 
           - name: fieldKey | type: string | description: Key representing a field from the trigger's [payload schema](https://dev.wix.com/docs/rest/business-management/automations/triggers/the-trigger-payload-schema.md) that has been configured as an [item selection filter](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/automations/triggers/filter-fields.md#item-selection). For example `formId`. 
           - name: values | type: array | description: Values selected for the filter field. 
 Return type: PROMISE<GetDynamicSchemaResponse>
  - name: dynamicSchema | type: object | description: A [JSON schema](https://json-schema.org/) corresponding to the filter selection sent in the request. 


```

### Examples

### getTriggerDynamicSchema
```javascript
import { triggerCatalog } from '@wix/automations';

async function getTriggerDynamicSchema(appId,options) {
  const response = await triggerCatalog.getTriggerDynamicSchema(appId,options);
};
```

### getTriggerDynamicSchema (with elevated permissions)
```javascript
import { triggerCatalog } from '@wix/automations';
import { auth } from '@wix/essentials';

async function myGetTriggerDynamicSchemaMethod(appId,options) {
  const elevatedGetTriggerDynamicSchema = auth.elevate(triggerCatalog.getTriggerDynamicSchema);
  const response = await elevatedGetTriggerDynamicSchema(appId,options);
}
```

### getTriggerDynamicSchema (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 getTriggerDynamicSchema(appId,options) {
  const response = await myWixClient.triggerCatalog.getTriggerDynamicSchema(appId,options);
};
```

---