Version 4.0

HomeHOME
  • API.V4.DataWrappers.IncidentTrigger Object Reference

    SMS Trigger that invokes an incident

    FieldTypeDescription
    CreateStamp System.DateTime Timestamp that the trigger was created.
    ChangeStamp System.DateTime Timestamp that the trigger was last updated.
    CreatedByUser System.String The username that created the trigger.
    ChangedByUser System.String The username that last updated the trigger.
    CompanyCode System.Int32 The unique numerical code identifying this customer
    PropertyGuid System.Guid The unique identifier for the property that the trigger is associated with.
    MessagingPhone System.String The 10-digit phone number associated with the incident for all messaging to occur through. Any sms messages sent to this number will be logged as part of the incident. This number may also optionally function as a hot-line for incoming voice calls.
    TriggerCode System.Int32 The unique numerical code identifying this trigger
    TriggerName System.String The name of the trigger
    IncidentName System.String The name that will be assigned to the incident that is created
    IncidentType System.String The type that will be assigned to the incident that is created
    IncidentDescription System.String The description of the incident that is created
    EnableAutoDescription System.Boolean If true the incident description will be automatically created using the text that appears after the keyword in the sms message.
    Keywords System.String[] The array of keywords that will invoke this trigger
    TriggerAccessList System.Int32 The unique numerical list code identifying the contact list containing the persons authorized to trigger the incident.
    TriggerAccessPinRequired System.Boolean If true the person triggering the incident will also be required to include a personal pin code when sending the keyword for this trigger.
    ShareEnabled System.Boolean If true the created incident will be shared with the specified trusted 3rd party entities
    Trusts API.V4.DataWrappers.IncidentTriggerTrust[] Any 3rd party trusts and their permissions
    Instructions API.V4.DataWrappers.IncidentTriggerInstructionsProfile Defines the actions taken for sending instructions to the occupants when the incident begins
    Alerts API.V4.DataWrappers.IncidentTriggerAlertingProfile Defines the actions taken for sending alerts to additional parties when the incident begins
    AllClear API.V4.DataWrappers.IncidentTriggerAllClearProfile Defines the actions taken for sending instructions to the occupants when the incident ends