Skip to main content
POST /v1/issuer/automations/{automation_id}/webhook API Key

Generate webhook token

Generate a webhook token for an automation, enabling external trigger capability.

If a token already exists, calling this endpoint replaces it with a new one.
The old token immediately stops working—update your external systems with the new URL.

Security: Tokens are long random strings. Treat the trigger_url as a secret.
If compromised, regenerate the token to invalidate the old URL.

Parameters

Name Location Type Description
automation_id * path string Automation ID
X-API-Key * header string Issuer API key for authentication

* Required parameter

Response

201 Webhook token generated

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.create_webhook(
    automation_id="example_automation_id"
)

Try It

Log in to test this endpoint directly from the documentation.

Log in