/rules/{id}/triggerManually triggers execution of a rule. Works for any trigger type - use this to run a rule on demand regardless of its configured schedule or trigger condition. For rules with a MANUAL trigger type, an optional manual_execute_amount can be provided to override the transfer amount. Returns an execution ID that can be polled via the rule-executions API to track the outcome. The rule ID must be present in the token's TRIGGER_RULES resources.
AuthorizationClick to expand
ApiKeyAuth Format: ApiKey <key>. Keys are scoped to an organization and carry explicit permissions.
Each key holds a list of permission entries. An entry specifies a scope and a resources
constraint. A request returns 403 if the key lacks the required scope, or if the requested
resource is outside the key's allowed list.
| Scope | Resources | Grants access to |
|---|---|---|
LIST_ACCOUNTS | none | List all accounts in the organization |
READ_ACCOUNTS | account IDs or * | Full account details and balance for a specific account |
LIST_RULES | none | List all rules in the organization |
READ_RULES | rule IDs or * | Full rule details (steps, conditions, actions) for a specific rule |
TRIGGER_RULES | rule IDs or * | Triggering rule executions |
READ_RULE_EXECUTIONS | rule IDs or * | Rule execution history - rule_id filter required |
READ_TRANSFERS | account IDs or * | Transfer history - account_id filter required |
MANUAL_TRANSFER | list of { source, target, max_amount? } sets | Creating manual transfers |
READ_CARDS | account IDs or * | Cards and card transactions - account_id filter required |
In: header
Path Parameters
id*stringThe rule ID.
Header Parameters
Idempotency-Key?stringA client-generated unique key to ensure idempotent processing. Requests with the same key within 24 hours return the original response without re-executing the operation. Recommended format: UUID v4.
X-Request-ID?stringA client-provided request identifier echoed back in the response `X-Request-ID` header and `request_id` body field. If omitted, the server generates one.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
| Field | Type | Description |
|---|---|---|
manual_execute_amount? | integer | Optional amount in cents to inject as the execution amount. Useful for MANUAL trigger rules as a substitute for remote API-driven amounts. |
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://api.getsequence.io/api/v1/rules/string/trigger" \ -H "Content-Type: application/json" \ -d '{ "manual_execute_amount": 150000 }'{
"request_id": "req_01HXYZ8888",
"data": {
"execution_id": "exec_01HXYZ9999"
}
}{
"error": {
"code": "resource_not_found",
"message": "Rule with id 'rule_123' was not found."
}
}{
"error": {
"code": "unauthorized",
"message": "Missing or invalid API key."
}
}{
"error": {
"code": "forbidden",
"message": "This API key does not have the required permission."
}
}{
"error": {
"code": "resource_not_found",
"message": "Rule with id 'rule_123' was not found."
}
}