/v1/issuer/automations/{automation_id}/webhook
API Key
Get webhook configuration
Get the webhook trigger URL and token for an automation.
Use case: Configure external systems (HR software, LMS, etc.) to call the trigger_url
when data changes, automatically issuing credentials.
The trigger_url includes the token and can be called without API key authentication.
The automation must have trigger_mode: webhook and status: active for triggers to work.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
automation_id
*
|
path | string | Automation ID |
X-API-Key
*
|
header | string | Issuer API key for authentication |
* Required parameter
Response
Content-Type: application/json
success
boolean
data
object
Webhook configuration for an automation
automation_id
*
string
The automation's unique identifier
Example: abc123xyz
automation_name
*
string
Display name of the automation
Example: Daily Badge Sync
trigger_url
*
string (uri)
Full URL to POST to trigger the automation
Example: https://api.aho.com/v1/hooks/automations/X_byFjHECwqaJccMOWumqjyJSNxZlEvV2JWL9XvF5VU
token
*
string
The webhook token (included in trigger_url)
Example: 32kbCpE2jTBD9ygyPOdcsIGIXpMLWvem0_0fOkydyks
generated_at
string (date-time)
nullable
When the token was generated
Example: 2025-01-15T10:00:00Z
trigger_mode
*
string
Current trigger mode of the automation
Allowed values: "manual", "scheduled", "webhook"
Example: webhook
enabled
*
boolean
Whether webhook triggers are allowed (true when trigger_mode=webhook and status=active)
Example: true
Code Examples
import os
from aho_sdk import AhoSdk
client = AhoSdk.issuer(api_key=os.environ["AHO_API_KEY"])
result = client.automations.get_webhook(
automation_id="example_automation_id"
)client = AhoSdk.issuer(api_key: ENV["AHO_API_KEY"])
result = client.automations.get_webhook(
automation_id: "example_automation_id"
)import { AhoSdk } from '@aho/sdk';
const client = AhoSdk.issuer({ apiKey: process.env.AHO_API_KEY });
const result = await client.automations.get_webhook({
automationId: "example_automation_id"
});curl -X GET 'https://api.aho.com/v1/issuer/automations/example_automation_id/webhook' \
-H 'X-API-Key: $AHO_API_KEY'Try It
Log in to test this endpoint directly from the documentation.
Log in