Property

Properties, distinct from attributes, are utilized for key-value pairs within the incident record. Unlike attributes, properties can trigger consequential actions when altered. Allowing the introduction of a dynamic element to the incident handling process where changes have direct and meaningful consequences on service experience and potentially the customer digital experience.

Events

The following events are available for properties:

Event TypeDescription
property.updatedTriggered when any property information is modified

The property object

Attributes
  • objectstring

    Type of the property, always "Property".

  • namestring or null

    Name of the property.

  • keystring

    Key of the property

  • valuestring, array of strings or null

    Value of the property.

Property
interface Property {
  object: "Property";
  name: string | null;
  key: string;
  value: string | string[] | null;
}
Example Property
{
  "object": "Property",
  "name": "Roadside Status",
  "key": "roadside_status",
  "value": "not_at_roadside"
}

Property Configuration

Like attributes, each integration is uniquely configured with the relevant set of properties available, tailored to your specific needs of your implementation. The properties available are dependent on operations undertaken to deliver the service. Combined these configurations curated by your Axitech representative, ensure that you are exposed to properties that can seamlessly integrate with your workflow.

For a better understanding of the properties available for consumption in your integration, please consult the corresponding supplement document. This versioned document is crafted specifically for your integration, provides detailed insights into the configured elements.

Should you have any inquiries or seek further clarification on the customized properties, please contact your Axitech representative.