Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.apten.ai/llms.txt

Use this file to discover all available pages before exploring further.

The guardrailTriggered webhook event is triggered whenever one or more guardrails are activated during a conversation with a lead. This can be used to monitor compliance, safety, or business rule violations in your assistant’s interactions.

​
Payload

{
  "event": "guardrailTriggered",
  "data": {
    "leadId": "19a6d1c9-4822-46b0-86be-a5b5b6e8615c",
    "externalLeadId": "003XX000004DHPY",
    "phone": "+13102919783",
    "channel": "sms",
    "guardrails": ["741d2650-f2ff-4842-ba70-af7343d5c464"]
  },
  "timestamp": "2025-08-22T16:03:16.065Z"
}

​
Properties

PropertyTypeDescription
eventstringThe webhook event type (guardrailTriggered).
data.leadIdstringThe unique identifier for the lead.
data.externalLeadIdstringThe CRM lead ID (Salesforce, HubSpot, or Close CRM).
data.phonestringThe phone number of the lead.
data.channelstringThe communication channel. Can be sms, email, call, or manual.
data.guardrailsstring[]Array of guardrail IDs that were triggered.
timestampstringThe ISO 8601 timestamp when the guardrails were triggered.