com.gigs.addon.updated

  • Name
    object
    Type
    string
    required
    Description

    Type of object is always event.

    Allowed values: event
  • Name
    id
    Type
    string
    required
    Description

    Unique identifier for the event.

    Example: "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol"
  • Name
    data
    Type
    Add-on
    required
    Description
  • 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.addon.updated.

    Allowed values: com.gigs.addon.updated
  • Name
    version
    Type
    string
    required
    Description

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

    Default: 2024-12-20

Example

{
  "object": "event",
  "id": "evt_0SNlurA049MEWV5gNTcQ5A07h3Ol",
  "data": {
    "object": "addon",
    "id": "add_0SNlurA049MEWV4VxLfwJc7PJtHc",
    "allowances": {
      "dataBytes": 10000000000,
      "voiceSeconds": 30000,
      "smsMessages": 100
    },
    "createdAt": "2021-01-21T19:12:28Z",
    "description": "Disable international roaming.",
    "name": "1GB Data Top-up",
    "price": {
      "amount": 999,
      "currency": "USD"
    },
    "provider": "p5",
    "recurrenceType": "oneTime",
    "status": "draft",
    "type": "topUp",
    "validity": {
      "unit": "day",
      "value": 7
    },
    "data": 10000000000,
    "dataUnit": "byte",
    "sms": 100,
    "smsUnit": "message",
    "voice": 30000,
    "voiceUnit": "second"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42Z",
  "type": "com.gigs.addon.updated",
  "version": "2024-12-20"
}