Events

Events are our way of letting you know when something happens in your account. When an event occurs, we create a new Event object. For example, when an contact is created, we create a contact.created event, and when an vehicle is updated, we create a vehicle.updated event. Certain actions within Axicloud might create multiple events.

Events occur when the state of another resource changes. The event’s data field embeds the resource’s state at the time of the change. For example, a contact.created event contains a contact, and an vehicle.updated event contains a vehicle.

Event Object

The event object provides information about a specific event triggered by the Axicloud Webhook Service.

Events are grouped into Event groups, which encapsulate a group of events like IncidentEvent. Each event group can have multiple event types. Which follow the pattern: resource.event

Properties:

• created_at: string
  • Represents the date and time when the event was created. Format: 'YYYY-MM-DDTHH:mm:ss'.
• api_version: string
  • Indicates the version of the Axicloud Webhook Service API, e.g., 'v1'.
• group: string
  • Specifies the group that the specific event belongs to. For now the only one is IncidentEevent
• event: string
  • Specifies the type of the event inside the specified group. It can be one of the event types
• subscription_id: string
  • Represents the identifier of the subscriber associated with the event.
• retry_count: number
  • Represents the number of times the event delivery was retried.
• metadata: array
  • Contains metadata related to relevant external systems. Each metadata object has the following properties:
    • key: string
      • Represents the key of the metadata.
    • value: string
      • Represents the value of the metadata.
• data: object
  • Contains specific data related to the event. The structure of this object depends on the event type.

Example:

{
  "created_at": "2023-01-01T12:00:00Z",
  "api_version": "v1",
  "group_type": "IncidentEvent",
  "event_type": "incident.updated",
  "subscription_id": "subscriber123",
  "retry_count": 0,
  "metadata": [
    {
      "key": "cams_case_reference_id",
      "value": "MSI/123456"
    }
  ],
  "data": {
    "incident_id": "incident123",
    "location": "New York"
    // ... other properties specific to the event
  }
}