> 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

# RunTrigger

# Package: triggers

# Namespace: AutomationsCustomTriggerService

# Method link: https://dev.wix.com/docs/api-reference/business-management/automations/triggers/custom-trigger/run-trigger.md

## Permission Scopes:
Access Verticals by Automations: SCOPE.CRM.ACCESS-VERTICALS-BY-AUTOMATIONS

## Introduction

Runs the automation associated with the trigger ID that you pass to it.

---

## REST API

### Schema

```
 Method: runTrigger
 Description: Runs the automation associated with the trigger GUID that you pass to it.
 URL: https://www.wixapis.com/v1/trigger-custom
 Method: POST
 Method parameters:
   param name: payload | type: payload | description: Optional payload object to pass to run trigger. Define the payload schema from sample data in the custom trigger configuration in the automations builder. 
   param name: triggerId | type: triggerId | description: Trigger GUID. You can find this in the custom trigger configuration in the automations builder. 
 Return type: RunTriggerResponse
  EMPTY-OBJECT {}


```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.triggers.AutomationsCustomTriggerService.runTrigger(options)
 Description: Runs the automation associated with the trigger GUID that you pass to it.
 Method parameters:
   param name: options | type: RunTriggerOptions  none 
        - name: triggerId | type: string | description: Trigger GUID. You can find this in the custom trigger configuration in the automations builder. 
        - name: payload | type: object | description: Optional payload object to pass to run trigger. Define the payload schema from sample data in the custom trigger configuration in the automations builder. 
 Return type: PROMISE<RunTriggerResponse>
  EMPTY-OBJECT {}


```

### Examples

### Trigger an automation with a button click
```javascript

/***** Backend *****/
import { customTrigger } from "@wix/automations";
import { auth } from '@wix/essentials';
import { Permissions, webMethod } from "wix-web-module";

export const runTriggerWithPayload = webMethod(
  Permissions.Anyone,
  async (payload) => {
    const triggerMethod = auth.elevate(customTrigger.runTrigger);

    // Your code here
    await triggerMethod({
      triggerId: 'a0f95461-4fea-4971-b2d8-86128ae3e6e9',
      payload,
    });
  }
);

/***** Frontend *****/
import { runTriggerWithPayload } from 'backend/trigger.web';

$w('#button1').onClick(() => {
  const payload = {
		firstName: "Amy",
		age: 50,
		favoriteFood: "pizza",
		favoriteColor: "green"
	};
	runTriggerWithPayload(payload);
})

```

### runTrigger (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 { customTrigger } from '@wix/automations';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { customTrigger },
  // Include the auth strategy and host as relevant
});


async function runTrigger(options) {
  const response = await myWixClient.customTrigger.runTrigger(options);
};
```

---