Trigger an incident
xmatters_trigger_an_incidentTrigger an xMatters incident by posting JSON to an integration function, notifying recipients and escalating as configured. Requires explicit write approval.
Instructions
Trigger an incident. POST /api/integration/1/functions/{id}/triggers. Posts JSON to the configured integration function. The documented apiKey query authentication is not exposed as a model argument; use server-configured authentication. Tenant-defined custom trigger payloads remain open JSON. Body fields: incidentDetails, recipients, properties, expirationInMinutes, overrideDeviceRestrictions, escalationOverride, bypassPhoneIntro, requirePhonePassword, voicemailOptions, senderOverrides, targetAllDevices, targetDeviceNames, priority. Reference: https://help.xmatters.com/xmapi/#trigger-an-incident Requires operator write opt-in and confirm:true; may notify recipients or change tenant data.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| body | Yes | Complete API JSON payload (including nested fields). See https://help.xmatters.com/xmapi/#trigger-an-incident | |
| path | Yes | ||
| query | No | API query parameters; arrays are comma-joined. Documented names: none. Pagination is explicit using offset and limit; results are not automatically combined. | |
| confirm | Yes | Explicit approval of this exact mutation. Operator must also enable XMATTERS_ALLOW_WRITES. |