Create and Launch Notify Scenarios
A Notify Scenario combines recipients, message content, launch conditions, and delivery behavior in a reusable definition.
In the API, a Scenario is a paging trigger.
Configure and launch Scenarios through the REST API. Limit configuration to notify_admin users and launch access to notify_operator, notify_admin, or Call Telemetry administrators.
Requirements
- Complete the Notify requirements.
- Create and verify at least one Paging Group.
- Prepare any audio file or text-to-speech content required by the Scenario.
- Decide who can launch the Scenario and how you will protect any webhook token.
Choose a Trigger Type
Set trigger_type to one of the supported values:
| Value | Launch Behavior |
|---|---|
manual | An authorized user or integration calls the execute endpoint. |
http_webhook | An external system calls the Scenario's tokenized webhook endpoint. |
scheduled | Call Telemetry launches the Scenario from its configured schedule and timezone. |
watch_list_hit | A watch-list match launches the Scenario. |
tdos_violation | A telephony denial-of-service violation launches the Scenario. |
emergency_call | Emergency-call detection launches the Scenario. |
custom_event | A supported custom event integration launches the Scenario. |
A dial trigger is configured through conditions["dial_trigger_extension"]. Depending on your deployment, Call Telemetry can detect the called number through JTAPI, CURRI, or CUBE XCC. Check detection-source availability before relying on a dial trigger.
Automated triggers depend on their source integration. Verify source health and test the complete event-to-delivery path before relying on one during an incident.
Configure the Scenario
Use the Paging Triggers API reference to create or update the Scenario.
| Field | Purpose |
|---|---|
name, description | Identify the Scenario clearly during an incident. |
enabled | Allow or prevent launches without deleting the configuration. |
action_type | Send text_page, audio_page, or both. |
target_group_ids | Target Cisco IP phone Paging Groups. |
target_recipient_group_ids | Target unified recipient groups for supported channels. |
text_message | Set the display text for text_page or both. |
audio_file_id, use_tts, tts_template, tts_voice | Configure uploaded audio or text-to-speech. |
delivery_method | Use unicast, multicast, or sequential delivery. |
priority, volume, override_active_calls | Control delivery urgency and phone behavior. |
conditions | Define dial or event-specific matching conditions. |
Validate the complete request against Create a Paging Trigger.
Launch a Scenario Manually
Execute an enabled Scenario:
POST /api/org/{org_id}/paging/triggers/{id}/execute
See Execute a Paging Trigger. The response creates a paging job that you can inspect for progress and delivery results.
Treat the execute operation as a privileged action. Confirm the Scenario name, recipients, message, and active-call behavior before sending the request.
Launch a Scenario Through a Webhook
For http_webhook, call the Scenario's webhook endpoint with an authenticated
request or the Scenario's webhook token:
POST /api/org/{org_id}/paging/triggers/{id}/webhook?token={webhook_token}
See Execute a Paging Trigger Webhook.
Treat the webhook URL as a credential:
- Store it in a secret manager.
- Send it only over HTTPS.
- Do not place it in source code, public documentation, or client-side logs.
- Redact query strings from reverse-proxy and application access logs.
- Replace the token if it is exposed.
Inspect and Control Jobs
After a launch:
- List Paging Jobs to find the run.
- Show a Paging Job to inspect its status.
- View Paging Job Results for per-recipient outcomes.
- Cancel a Paging Job if delivery should stop.
- Retry Failed Recipients after correcting a transient problem.