---
name: "SmartTapToRunAbility.trigger"
mode: "api"
versionRequirements:
  - { name: "@ray-js/panel-sdk", version: "1.11.0" }
title: "trigger"
---

## SmartTapToRunAbility.trigger

> [VERSION] @ray-js/panel-sdk >= 1.11.0

> 💡 Supports single devices only; groups are not supported. Note: The sample response is for reference only and contains fields beyond the defined response parameters. Do not use any data other than what is defined in this document, otherwise it may cause application errors.

### Description

Ignore automation conditions and trigger the Tap-to-Run directly

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `options` | `TriggerTapToRunParams` | Yes | Trigger parameters, including ruleId |

### Return Value

Type: `Promise<boolean>`

Whether the execution succeeded

### Referenced Types

##### `type` TriggerTapToRunParams

| Property | Type | Description |
| --- | --- | --- |
| `ruleId` | `string` | Rule ID, obtainable from triggerRuleId in the bound Tap-to-Run list |


### Examples

#### Example

```typescript
await sdm.tapToRun.trigger({ ruleId: 'rule_abc123' });
console.log('Tap-to-Run triggered');
```