com.gigs.device.updated

  • Name
    object
    Type
    string
    required
    Description

    Type of object is always event.

  • Name
    id
    Type
    string
    required
    Description

    Unique identifier for the event.

    Example: evt_0SNlurA049MEWV5gNTcQ5A07h3Ol
  • Name
    data
    Type
    object
    required
    Description
    • Name
      object
      Type
      string
      required
      Description

      Type of object is always device.

    • Name
      id
      Type
      string
      required
      Description

      Unique identifier for the device.

      Example: dev_0SNlurA049MEWV55CrA9qMvI2FVJ
    • Name
      metadata
      Type
      object
      PREVIEW
      required
      Description
      A set of key-value pairs, to store metadata related to the resource.
    • Name
      imei
      Type
      nullable string
      required
      Description

      The IMEI (international mobile equipment identity) of the device if provided.

      Example: 492388841798923
    • Name
      model
      Type
      nullable object
      required
      Description
    • Name
      name
      Type
      nullable string
      required
      Description

      An optional custom name for the device.

      Example: Anna's iPhone 12 Pro
    • Name
      sims
      Type
      array
      required
      Description

      List of SIMs added to this device.

    • Name
      user
      Type
      nullable object
      required
      Description
    • Name
      createdAt
      Type
      string
      required
      Description

      Time when the device was created.

      Example: 2021-02-14T19:38:34Z
  • Name
    datacontenttype
    Type
    string
    required
    Description

    The RFC 2046 content-type.

    Example: application/json
    Default: application/json
  • Name
    previousData
    Type
    object
    Description
    Present only for events of type `*.updated`. Contains the values fields in the schema had prior to the update. This field is the result of a shallow diff of the previous schema (i.e., if a nested field has changed, then the entire object will be included).
    • Name
      project
      Type
      string
      required
      Description

      Unique identifier for the project where the event occurred.

      Example: gigs
    • Name
      source
      Type
      string
      required
      Description

      URI identifying the event source.

      Example: https://api.gigs.com
      Default: https://api.gigs.com
    • Name
      specversion
      Type
      string
      required
      Description

      The CloudEvents spec version.

      Example: 1.0
      Default: 1.0
    • Name
      time
      Type
      string
      required
      Description

      Time when the event occurred.

      Example: 2022-03-16T14:12:42Z
    • Name
      type
      Type
      string
      required
      Description

      Type is always com.gigs.device.updated.

    • Name
      version
      Type
      string
      required
      Description

      API version used to serialize the data and the event itself.

      Default: 2024-08-29

    Example

    {
      "object": "event",
      "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
      "data": {
        "object": "device",
        "id": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
        "imei": "492388841798923",
        "model": {
          "object": "deviceModel",
          "id": "dmd_0SNlurA04OUskUGfGAn3Rh",
          "brand": "Apple",
          "name": "iPhone 12 Pro",
          "simTypes": [
            "eSIM",
            "pSIM"
          ],
          "type": "smartphone"
        },
        "name": "Anna's iPhone 12 Pro",
        "user": {
          "object": "user",
          "id": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
          "birthday": "2017-07-21",
          "email": "jerry@example.com",
          "emailVerified": true,
          "fullName": "Jerry Seinfeld",
          "preferredLocale": "en-US",
          "createdAt": "2021-01-21T19:38:34Z"
        },
        "createdAt": "2021-02-14T19:38:34Z"
      },
      "datacontenttype": "application/json",
      "project": "gigs",
      "source": "https://api.gigs.com",
      "specversion": "1.0",
      "time": "2022-03-16T14:12:42Z",
      "type": "com.gigs.device.updated",
      "version": "2024-08-29"
    }