> 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 # ResolveActions # Package: actions # Namespace: ActionCatalogService # Method link: https://dev.wix.com/docs/api-reference/business-management/automations/actions/action-catalog/resolve-actions.md ## Permission Scopes: Set Up Automations: SCOPE.CRM.SETUP-AUTOMATIONS ## Introduction Returns action configurations that are installed on the site and exposed to Wix users. --- ## REST API ### Schema ``` Method: resolveActions Description: Returns action configurations that are installed on the site and exposed to Wix users. URL: https://www.wixapis.com/v1/actions/resolve Method: POST Method parameters: param name: query | type: QueryV2 - ONE-OF: - name: paging | type: Paging | description: Paging options to limit and offset the number of items. - name: limit | type: integer | description: Number of items to load. - name: offset | type: integer | description: Number of items to skip in the current sort order. - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). - name: sort | type: array | description: Sort object. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC - name: fields | type: array | description: Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. - name: fieldsets | type: array | description: Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. Return type: ResolveActionsResponse - name: actions | type: array | description: Retrieved actions. - name: id | type: string | description: Action GUID. - name: appId | type: string | description: The GUID of the app that defines the action. - name: actionKey | type: string | description: Human-readable identifier for the action. - name: inputSchema | type: object | description: The action [input schema](https://dev.wix.com/docs/rest/business-management/automations/actions/about-actions.md#the-input-schema) as defined in the app dashboard. - name: outputSchema | type: object | description: The action [output schema](https://dev.wix.com/docs/rest/business-management/automations/actions/about-actions.md#the-output-schema) as defined in the app dashboard. - name: displayName | type: string | description: Action name displayed in the site dashboard to Wix users. For example, "Send SMS" or "Create Coupon". - name: description | type: string | description: Action description displayed in the site dashboard to Wix users. - name: implementedMethods | type: ImplementedMethods | description: The optional service plugin methods that are implemented for this action. Invoke is required and therefore excluded from this list. - name: validateConfiguration | type: boolean | description: Whether Validate Configuration is implemented. - name: duplicateInputMapping | type: boolean | description: Whether Duplicate Input Mapping is implemented. - name: generateApplicationAutomationInputMapping | type: boolean | description: Whether Generate Application Automation Input Mapping is implemented. - name: getQuotaInfo | type: boolean | description: Whether Get Quota Info is implemented. - name: onBeforeSave | type: boolean | description: Whether On Before Save is implemented. - name: onReset | type: boolean | description: Whether On Reset is implemented. - name: generateActionInputMappingFromTemplate | type: boolean | description: Whether Generate Action Input Mapping From Template is implemented. - name: onRemove | type: boolean | description: Whether On Remove is implemented. - name: getDynamicInputSchema | type: boolean | description: Whether Get Dynamic Input Schema is implemented. - name: mergeInputMappings | type: boolean | description: Whether Merge Input Mappings is implemented. - name: getDynamicOutputSchema | type: boolean | description: Whether Get Dynamic Output Schema is implemented. - name: generateInputMappingFromIntent | type: boolean | description: Whether Generate Input Mapping From Intent is implemented. - name: interfaceConfiguration | type: InterfaceConfiguration | description: The chosen user interface for the action. The UI is displayed to the Wix user in the site dashboard when they configure the action. - ONE-OF: - name: genericOptions | type: GenericOptions | description: Details for the generic UI. - name: uiSchema | type: object | description: UI schema. - name: type | type: Type | description: Type of action configuration UI. - enum: - UNKNOWN_TYPE: Unknown action configuration UI. - GENERIC: The generic action configuration UI. This requires you to provide a [UI schema](https://dev.wix.com/docs/rest/business-management/automations/actions/about-actions.md#the-ui-schema). - name: icon | type: Image | description: Action icon displayed in the site dashboard to Wix users. - name: id | type: string | description: WixMedia image GUID. - name: url | type: string | description: Image URL. - name: height | type: integer | description: Original image height. - name: width | type: integer | description: Original image width. - name: altText | type: string | description: Image alt text. - name: filename | type: string | description: Image filename. - name: createdDate | type: string | description: Date and time the action was created. - name: updatedDate | type: string | description: Date and time the action was updated. - name: componentId | type: string | description: Action component GUID. - name: componentVersion | type: string | description: Component version at the time the action was created. - name: baseUri | type: string | description: Action base URI. - name: paging | type: PagingMetadataV2 | description: Paging metadata of the response. - name: count | type: integer | description: Number of items returned in the response. - name: offset | type: integer | description: Offset that was requested. - name: total | type: integer | description: Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field. - name: cursors | type: Cursors | description: Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. ``` ### Examples ### Resolve Actions ```curl curl -X POST \ `https://www.wixapis.com/v1/actions/resolve` \ -H 'Authorization: ' \ -H "Content-Type:application/json" -d "{\"query\":{\"paging\":{\"limit\":2}}}" ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.actions.ActionCatalogService.resolveActions(options) Description: Returns action configurations that are installed on the site and exposed to Wix users. Method parameters: param name: options | type: ResolveActionsOptions none - name: query | type: QueryV2 | description: Query options. - ONE-OF: - name: paging | type: Paging | description: Paging options to limit and offset the number of items. - name: limit | type: integer | description: Number of items to load. - name: offset | type: integer | description: Number of items to skip in the current sort order. - name: cursorPaging | type: CursorPaging | description: Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). - name: sort | type: array | description: Sort object. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC - name: fields | type: array | description: Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. - name: fieldsets | type: array | description: Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. Return type: PROMISE - name: actions | type: array | description: Retrieved actions. - name: _id | type: string | description: Action GUID. - name: appId | type: string | description: The GUID of the app that defines the action. - name: actionKey | type: string | description: Human-readable identifier for the action. - name: inputSchema | type: object | description: The action [input schema](https://dev.wix.com/docs/rest/business-management/automations/actions/about-actions.md#the-input-schema) as defined in the app dashboard. - name: outputSchema | type: object | description: The action [output schema](https://dev.wix.com/docs/rest/business-management/automations/actions/about-actions.md#the-output-schema) as defined in the app dashboard. - name: displayName | type: string | description: Action name displayed in the site dashboard to Wix users. For example, "Send SMS" or "Create Coupon". - name: description | type: string | description: Action description displayed in the site dashboard to Wix users. - name: implementedMethods | type: ImplementedMethods | description: The optional service plugin methods that are implemented for this action. Invoke is required and therefore excluded from this list. - name: validateConfiguration | type: boolean | description: Whether Validate Configuration is implemented. - name: duplicateInputMapping | type: boolean | description: Whether Duplicate Input Mapping is implemented. - name: generateApplicationAutomationInputMapping | type: boolean | description: Whether Generate Application Automation Input Mapping is implemented. - name: getQuotaInfo | type: boolean | description: Whether Get Quota Info is implemented. - name: onBeforeSave | type: boolean | description: Whether On Before Save is implemented. - name: onReset | type: boolean | description: Whether On Reset is implemented. - name: generateActionInputMappingFromTemplate | type: boolean | description: Whether Generate Action Input Mapping From Template is implemented. - name: onRemove | type: boolean | description: Whether On Remove is implemented. - name: getDynamicInputSchema | type: boolean | description: Whether Get Dynamic Input Schema is implemented. - name: mergeInputMappings | type: boolean | description: Whether Merge Input Mappings is implemented. - name: getDynamicOutputSchema | type: boolean | description: Whether Get Dynamic Output Schema is implemented. - name: generateInputMappingFromIntent | type: boolean | description: Whether Generate Input Mapping From Intent is implemented. - name: interfaceConfiguration | type: InterfaceConfiguration | description: The chosen user interface for the action. The UI is displayed to the Wix user in the site dashboard when they configure the action. - ONE-OF: - name: genericOptions | type: GenericOptions | description: Details for the generic UI. - name: uiSchema | type: object | description: UI schema. - name: type | type: Type | description: Type of action configuration UI. - enum: - UNKNOWN_TYPE: Unknown action configuration UI. - GENERIC: The generic action configuration UI. This requires you to provide a [UI schema](https://dev.wix.com/docs/rest/business-management/automations/actions/about-actions.md#the-ui-schema). - name: icon | type: string | description: Action icon displayed in the site dashboard to Wix users. - name: _createdDate | type: Date | description: Date and time the action was created. - name: _updatedDate | type: Date | description: Date and time the action was updated. - name: componentId | type: string | description: Action component GUID. - name: componentVersion | type: string | description: Component version at the time the action was created. - name: baseUri | type: string | description: Action base URI. - name: paging | type: PagingMetadataV2 | description: Paging metadata of the response. - name: count | type: integer | description: Number of items returned in the response. - name: offset | type: integer | description: Offset that was requested. - name: total | type: integer | description: Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. - name: tooManyToCount | type: boolean | description: Flag that indicates the server failed to calculate the `total` field. - name: cursors | type: Cursors | description: Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. ``` ### Examples ### Resolve Actions Returns actions available on the site with paging. ```javascript import { actionCatalog } from "@wix/automations"; async function resolveActions() { const response = await actionCatalog.resolveActions({ query: { paging: { limit: 2 }, }, }); return response; } /* Promise resolves to: * { * "actions": [ * { * "appId": "553c79f3-5625-4f38-b14b-ef7c0d1e87df", * "actionKey": "assignPoints", * "inputSchema": { * "description": "Schema that is sent when assignPoints action is invoked", * "properties": { * "displayName": { "type": "string", "title": "Display Name" }, * "pointsAmount": { "type": "number", "title": "Points Amount" }, * "contactId": { "format": "uuid", "title": "Contact Id", "type": "string" } * }, * "title": "Assign points input schema", * "type": "object", * "$schema": "http://json-schema.org/draft-07/schema" * }, * "outputSchema": { "$schema": "http://json-schema.org/draft-07/schema" }, * "displayName": "Give loyalty points", * "description": "Grow & retain your customer base with an incentive program for returning customers.", * "metadata": { "hidden": false }, * "executionType": "SYNC", * "source": { "type": "DEV_CENTER" }, * "_id": "cc9c5179-af66-404e-b84b-0c45978a1399" * } * ], * "paging": { * "count": 2, * "offset": 0, * "total": 48, * "hasNext": true * } * } */ ``` ### resolveActions (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 { actionCatalog } from '@wix/automations'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { actionCatalog }, // Include the auth strategy and host as relevant }); async function resolveActions(options) { const response = await myWixClient.actionCatalog.resolveActions(options); }; ``` ---