POST
/v1/issuer/automations/{id}/trigger
API Key
Trigger an automation
Manually trigger an automation to run. The automation must be in active status.
Returns immediately with a run ID - actual execution happens in the background.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
id
*
|
path | string | Automation ID |
X-API-Key
*
|
header | string | Issuer API key for authentication |
* Required parameter
Response
200
Automation triggered
Content-Type: application/json
success
boolean
data
object
Result of triggering an automation
message
*
string
Result message
Example: Automation triggered
run_id
*
string
Hashid of the created run log
Example: qFeHSnxBkguhubshOLT0
status
*
string
Initial status of the run
Allowed values: "pending"
Example: pending
Code Examples
import os
from aho_sdk import AhoSdk
client = AhoSdk.issuer(api_key=os.environ["AHO_API_KEY"])
result = client.automations.trigger(
id="example_id"
)client = AhoSdk.issuer(api_key: ENV["AHO_API_KEY"])
result = client.automations.trigger(
id: "example_id"
)import { AhoSdk } from '@aho/sdk';
const client = AhoSdk.issuer({ apiKey: process.env.AHO_API_KEY });
const result = await client.automations.trigger({
id: "example_id"
});curl -X POST 'https://api.aho.com/v1/issuer/automations/example_id/trigger' \
-H 'X-API-Key: $AHO_API_KEY'Try It
Log in to test this endpoint directly from the documentation.
Log in