A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "obt_9f4c02a71e6d3b85",
"provider": "",
"triggerKey": "appointment_scheduled",
"providerEvent": "APPOINTMENT_CREATE",
"delivery": "static_webhook",
"agentId": "agt_4f9c2b7e10a24d51",
"callerNumberId": "pn_6a2f9c31e07b4d58",
"messageCategory": "informational",
"audienceType": "consumer",
"consentBasis": "ebr",
"enabled": true,
"consentAttestedAt": "2026-07-13T15:20:00.000Z",
"mapping": [
{
"var": "recipient_phone",
"eventPath": [
"customer",
"phone"
],
"transform": "phone_normalize"
}
],
"createdAt": "2026-07-13T15:04:00.000Z",
"updatedAt": "2026-07-13T15:20:00.000Z"
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Enable or disable an outbound trigger
Enable or disable a trigger. ENABLING requires a standing consent attestation (consentAttested=true) and stands up its delivery (a no-op for a static webhook; a provider subscription for subscription-delivery). DISABLING tears down any provider subscription. Enabling makes the trigger originate a real call on every matched event.
A valid request URL is required to generate request examples{
"success": true,
"data": {
"id": "obt_9f4c02a71e6d3b85",
"provider": "",
"triggerKey": "appointment_scheduled",
"providerEvent": "APPOINTMENT_CREATE",
"delivery": "static_webhook",
"agentId": "agt_4f9c2b7e10a24d51",
"callerNumberId": "pn_6a2f9c31e07b4d58",
"messageCategory": "informational",
"audienceType": "consumer",
"consentBasis": "ebr",
"enabled": true,
"consentAttestedAt": "2026-07-13T15:20:00.000Z",
"mapping": [
{
"var": "recipient_phone",
"eventPath": [
"customer",
"phone"
],
"transform": "phone_normalize"
}
],
"createdAt": "2026-07-13T15:04:00.000Z",
"updatedAt": "2026-07-13T15:20:00.000Z"
}
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}{
"type": "about:blank",
"title": "<string>",
"status": 123,
"detail": "<string>",
"instance": "<string>",
"code": "<string>",
"errors": [
{
"field": "<string>",
"message": "<string>"
}
]
}Authorizations
Flowyte secret API key (Authorization: Bearer flowyte_sk_live_…). Scope-gated; is scoped to your organization — a key can never reach another tenant. The listed scopes in each operation's apiKey requirement are the scopes that key must hold. The tokenUrl is nominal: keys are minted in the dashboard.
- Token URL
- /api/v1/api-keys
Path Parameters
The compiled trigger id (returned by createOutboundTrigger / listOutboundTriggers).
Body
Response
The updated trigger.
A compiled outbound trigger ("when {event} in {provider} → call {agent}"). The server-authored fields (agentId, callerNumberId, messageCategory, intentType, consentBasis) are PINNED at compile; the inbound payload can never choose them. It lands disabled and the operator enables it (a standing consent attestation).
Show child attributes
Show child attributes
Show child attributes
Show child attributes