Configure a webhook-triggered automation

Use webhook trigger when external system needs to start Yarken automation through HTTP request.

Example: Start renewal review from an external system

Scenario: External contract application starts a review when renewal deadline approaches.

1. Choose Webhook trigger. Copy endpoint and token into approved external integration.

2. Limit permitted IP addresses or CIDR ranges when sender addresses are known.

3. Provide example JSON containing contract ID and renewal date, then map values into later steps.

4. Send test request and verify corresponding run appears in Run History.

5. If run never starts, inspect Blocked Requests. HTTP 202 does not prove request passed token and IP checks.

Set up webhook trigger

1. Go to Admin > AI Studio > Orchestrate > Automations.

2. Create automation or open existing one.

3. Select Trigger in Builder.

4. Under When it runs, select Webhook.

5. In Example request body, enter sample JSON payload, if useful. This helps identify fields for later steps; it does not send request.

6. Under Allowed IP addresses, enter permitted IP addresses or CIDR ranges, separated by commas. Leave blank only if requests from any sender with valid token should be allowed.

7. Select Generate token. Copy token immediately and store securely. Token shown once.

8. Copy webhook URL and configure external sender to POST to it.

9. Set request header X-Yarken-Webhook-Token to generated token and Content-Type to application/json for JSON body.

10. Configure downstream automation steps. Save, Test run, then Activate.

Avoid duplicate runs

For retryable events, include Idempotency-Key header with stable identifier such as invoice or ticket number. Retry with same key within 24 hours does not start another run.

Webhook endpoint accepts POST requests with JSON or form body up to 1 MB while automation active. Requests receive HTTP 202 even if token invalid; over-limit requests receive 429. Check Blocked Requests for rejected requests.

Troubleshoot

• Wrong or missing token: Verify X-Yarken-Webhook-Token header; generate new token if necessary.

• IP address isn't on the allowed list: Update allowed IP addresses to include sender.

• Duplicate event: Check Idempotency-Key.

• No run in Run History: Check Blocked Requests, automation activation, and request limits.

Security: Regenerating token invalidates previous token immediately. Update external sender after regeneration. Do not paste actual tokens into support tickets or documentation.