Skip to main content
POST
Create Trigger

Authentication

Requires JWT token or Platform API key via Authorization: Bearer <token> header.

Path Parameters

string
required
Agent UUID

Body Parameters

string
required
Trigger name (1-255 characters)
string
required
Message to send when webhook fires. Supports {{payload.*}} dot-path substitution from JSON payload
boolean
default:"true"
Whether the trigger is active

Example Request

Response

Save the webhook secret immediately! It’s shown only once at creation time. You’ll need it to authenticate webhook requests.

Webhook URL

The returned webhook_url is the endpoint external systems should POST to:

Webhook Authentication

Include the secret in one of two ways:

Option 2: X-Hub-Signature-256 (GitHub-style HMAC)

Template Variable Substitution

The message_template supports {{payload.*}} dot-path access to any field in the webhook JSON payload. Example Payload:
Template:
Rendered:

Use Cases

GitHub Webhooks

  • Deployment status updates
  • Pull request events
  • CI/CD pipeline notifications
  • Issue/PR comments

Monitoring & Alerts

  • PagerDuty incidents
  • Datadog/New Relic alerts
  • CloudWatch alarms
  • Sentry error notifications

Business Events

  • Stripe payment notifications
  • Customer signup webhooks
  • Order fulfillment status
  • API usage alerts

Error Responses

400 Bad Request

  • Missing required fields
  • Invalid message template
  • Name exceeds 255 characters

404 Not Found

  • Agent not found or you don’t have access

429 Too Many Requests

  • Rate limit exceeded

See Also