---
name: "triggerRule"
mode: "api"
versionRequirements:
  - { name: "Base Library", version: "2.14.0" }
title: "device.triggerRule - 触发联动规则"
---

## triggerRule

> [VERSION] Base Library >= 2.14.0

### Description

Trigger execution of the automation rule

### Parameters

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `params` | `IRuleIdOption` | Yes | Includes rule ID |

### Return Value

Type: `Promise<boolean>`

Whether triggering succeeded

### Referenced Types

##### `interface` IRuleIdOption

| Property | Type | Description |
| --- | --- | --- |
| `ruleId` | `string` | Rule ID |


### Examples

#### Trigger automation rule

```ts
ty.triggerRule({
  ruleId: 'rule_001',
}).then((success) => {
  console.log('Trigger result', success);
});
```