# About the Trigger Catalog API

The Trigger Catalog API allows you to manage [triggers](fallback::https://dev.wix.com/docs/rest/business-management/automations/triggers/about-triggers) for your app. It also allows you to retrieve the catalog of triggers available to Wix users on a site. With this API you can:

- [Create](fallback::https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-catalog/create-trigger), [update](fallback::https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-catalog/update-trigger), and [delete](fallback::https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-catalog/delete-trigger-by-app-id-and-key) triggers from your app.
- [Query triggers](fallback::https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-catalog/query-triggers) to retrieve available triggers.
- [Resolve triggers](fallback::https://dev.wix.com/docs/rest/business-management/automations/triggers/trigger-catalog/resolve-triggers) installed on the current site, based on the specified app ID and query configurations.
- [Retrieve a specific trigger](fallback::https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-catalog/get-trigger-by-app-id-and-key) by its app ID and trigger key.
- [Retrieve a trigger's dynamic schema](fallback::https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-catalog/get-trigger-dynamic-schema) including its [filter fields](fallback::https://dev.wix.com/docs/api-reference/business-management/automations/triggers/about-triggers#filter-fields).

## Before you begin

It's important to note the following points before starting to code:

- You can only create, update, and delete triggers for [apps you own or collaborate on](fallback::https://dev.wix.com/docs/build-apps/develop-your-app/app-dashboard-setup/manage-collaborators).
- A site's trigger catalog only contains the triggers of apps that are installed on the site.

## Use case

[Retrieve the triggers provided by a specific app on a site](fallback::https://dev.wix.com/docs/rest/business-management/automations/triggers/trigger-catalog/sample-flow#fetch-the-triggers-owned-by-wix-inbox-on-a-site).

## See also

- [About triggers](fallback::https://dev.wix.com/docs/api-reference/business-management/automations/triggers/about-triggers)
- [Add a trigger to your app](fallback::https://dev.wix.com/docs/api-reference/business-management/automations/triggers/add-a-trigger-to-your-app)
- [About the Wix Automations Trigger Provider Service Plugin](fallback::https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-provider-service-plugin/introduction#about-the-wix-automations-trigger-provider-service-plugin)
- [About automations](fallback::https://dev.wix.com/docs/api-reference/business-management/automations/introduction)

@sdk_package_setup

# Sample Flow

This article presents a possible use case and corresponding sample flow that you can support. This can be a helpful jumping off point as you plan your implementation.

## Retrieve the triggers provided by a specific app on a site

To view the available triggers for the Wix Inbox app that are installed on a site, call [Resolve Triggers](fallback::https://dev.wix.com/docs/api-reference/business-management/automations/triggers/trigger-catalog/resolve-triggers) and specify the [Wix Inbox app ID](portalId::d1972c09-74e2-4d36-a6f2-54e3310d4ad9resourceId::9314331e-07dc-489d-a9b0-03b36a540c5c*fallback::https://dev.wix.com/docs/rest/articles/getting-started/apps-created-by-wix) as a filter:

```json
{
  "query": {
    "filter": {
      "appId": "141fbfae-511e-6817-c9f0-48993a7547d1"
    }
  }
}
```

Resolve Triggers returns an array of triggers owned by Wix Inbox. Here’s an example of a possible response:

```json
{
  "results": [
    {
      "appId": "141fbfae-511e-6817-c9f0-48993a7547d1",
      "triggerKey": "wix_chat-message_sent_to_uou",
      "payloadDataSchema": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-07/schema",
        "required": ["summary"],
        "properties": {
          "summary": {
            "type": "string",
            "title": "Chat message summary",
            "examples": ["Thanks for signing up."],
            "description": "A short preview text for a chat message."
          },
          "contactId": {
            "format": "uuid",
            "examples": ["b9515494-04d2-4d53-a44c-4e0c54894daf"],
            "description": "A unique identifier for the contact the message was sent to.",
            "title": "Contact ID",
            "type": "string",
            "identityType": "contact"
          },
          "visitorId": {
            "format": "uuid",
            "examples": ["3e884e7f-da65-53dc-ab09-3655e283dd40"],
            "description": "A unique identifier for the site visitor the message was sent to.",
            "title": "Visitor ID",
            "type": "string",
            "identityType": "visitor"
          }
        }
      },
      "displayName": "Chat message sent",
      "maturity": "GA",
      "filters": [],
      "metadata": {
        "hidden": false
      },
      "implementedMethods": {
        "validateConfiguration": false,
        "getDynamicSchema": false,
        "refreshPayload": false
      },
      "source": {
        "type": "DEV_CENTER"
      }
    },
    {
      "appId": "141fbfae-511e-6817-c9f0-48993a7547d1",
      "triggerKey": "wix_chat-message_receive_from_uou",
      "payloadDataSchema": {
        "type": "object",
        "$schema": "http://json-schema.org/draft-07/schema",
        "required": ["summary"],
        "properties": {
          "summary": {
            "type": "string",
            "title": "Chat message summary",
            "examples": ["Thanks for signing up."],
            "description": "A short preview text for a chat message."
          },
          "contactId": {
            "format": "uuid",
            "examples": ["b9515494-04d2-4d53-a44c-4e0c54894daf"],
            "description": "A unique identifier for the contact who sent the message.",
            "title": "Contact ID",
            "type": "string",
            "identityType": "contact"
          },
          "visitorId": {
            "format": "uuid",
            "examples": ["3e884e7f-da65-53dc-ab09-3655e283dd40"],
            "description": "A unique identifier for a specific site visitor who sent the message.",
            "title": "Visitor ID",
            "type": "string",
            "identityType": "visitor"
          }
        }
      },
      "displayName": "Inbox message received (chat or email)",
      "maturity": "GA",
      "filters": [],
      "metadata": {
        "hidden": false
      },
      "implementedMethods": {
        "validateConfiguration": false,
        "getDynamicSchema": false,
        "refreshPayload": false
      },
      "source": {
        "type": "DEV_CENTER"
      }
    }
  ],
  "paging": {
    "count": 2,
    "offset": 0,
    "total": 2,
    "hasNext": false
  }
}
```

Mintlify Sandbox

Coding Examples

Overview

Sled Tests

Go Headless

Studio Two

Dashboard Extensions

Backend Extensions

Site Extensions

Extend Websites with SDK

Wix APIs and References

Build Apps

Wix Design System (WDS)

Client (Deprecated)

API Preview

Wix CLI

Contexts

Ricos

Extend Websites with Velo

API Reference

Velo

Picasso

Get Trigger Dynamic Schema