[Beta] IssueCreated Event Schema

[Beta] IssueCreated Webhook Payload

Example

{
    "eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
    "eventTime": "1970-01-20T06:39:05.683Z",
    "eventType": "IssueCreated",
    "orgId": 20936,
    "webhookId": "1411751028848270",
    "data": {
        "issue": {
            "asset": {
                "entryType": "tracked",
                "externalIds": {
                    "maintenanceId": "250020"
                },
                "id": "281474982859091",
                "name": "trailer 123"
            },
            "assignedTo": {
                "id": "938172",
                "type": "driver"
            },
            "createdAtTime": "2019-06-13T19:08:25Z",
            "description": "Oil spill in left corner of SF1",
            "dueDate": "2019-06-13T19:08:25Z",
            "externalIds": {
                "maintenanceId": "250020"
            },
            "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
            "issueSource": {
                "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                "type": "form"
            },
            "mediaList": [
                {
                    "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
                    "processingStatus": "processing",
                    "url": "https://samsara-forms-submission-media-uploads.s3.us-west-2.amazonaws.com/123456",
                    "urlExpiresAt": "2019-06-13T19:08:25Z"
                }
            ],
            "priority": "high",
            "status": "open",
            "submittedAtTime": "2019-06-13T19:08:25Z",
            "submittedBy": {
                "id": "938172",
                "type": "driver"
            },
            "title": "Oil spill",
            "updatedAtTime": "2019-06-13T19:08:25Z"
        }
    }
}

Reference

Property NameDescription
issue
object
Issue response object.
 asset
 object
Tracked or untracked (i.e. manually entered) asset object.
  entryType
  string
The type of entry for the asset. Valid values: tracked, untracked.
  externalIds
  object
A map of external ids
  id
  string
ID of a tracked asset. Included if 'entryType' is tracked.
  name
  string
Name of an untracked (i.e. manually entered) asset.
 assignedTo
 object
User or driver object.
  id
  string
ID of the polymorphic user.
  type
  string
The type of the polymorphic user. Valid values: driver, user.
 createdAtTime
 string
Creation time of the issue. UTC timestamp in RFC 3339 format.
 description
 string
Description of the issue. Included if the issue was given a description.
 dueDate
 string
Due date of the issue. UTC timestamp in RFC 3339 format. Included if the issue was assigned a due date.
 externalIds
 object
A map of external ids
 id
 string
ID of the issue.
 issueSource
 object
Contains information about where an issue came from.
  id
  string
ID of the issue's source object. The format depends on the 'type'. Included if 'type' is not 'ad-hoc'.
  type
  string
The type of issue source. Valid values: form, ad-hoc.
 mediaList
 object array
List of media objects for the issue. Included if the issue has media.
  id
  string
ID of the media record.
  processingStatus
  string
Status of the media record. Valid values: unknown, processing, finished.
  url
  string
URL containing a link to associated media content. Included if 'processingStatus' is 'finished'.
  urlExpiresAt
  string
Expiration time of the media record 'url'. UTC timestamp in RFC 3339 format.
 priority
 string
Priority of the issue. Included if the issue was assigned a priority. Valid values: low, medium, high.
 status
 string
Status of the issue. Valid values: open, inProgress, resolved, dismissed.
 submittedAtTime
 string
Submission time of the issue. UTC timestamp in RFC 3339 format.
 submittedBy
 object
User or driver object.
  id
  string
ID of the polymorphic user.
  type
  string
The type of the polymorphic user. Valid values: driver, user.
 title
 string
Title of the issue.
 updatedAtTime
 string
Update time of the issue. UTC timestamp in RFC 3339 format.

Did this page help you?