com.gigs.user.address.created

  • 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 userAddress.

    • Name
      id
      Type
      string
      required
      Description

      Unique identifier for the address.

      Example: adr_0SNlurA049MEWV5ELDmnaqVXgTFT
    • Name
      city
      Type
      string
      required
      Description

      The city/municipality of the address.

      Example: New York City
    • Name
      country
      Type
      string
      required
      Description

      The ISO 3166-1 alpha-2 country code of the address.

      Example: US
    • Name
      line1
      Type
      string
      required
      Description

      The first line of the address, e.g. street and house number.

      Example: 129 West 81st Street
    • Name
      line2
      Type
      nullable string
      required
      Description

      The second line of the address, e.g. apartment number.

      Example: Apartment 5A
    • Name
      postalCode
      Type
      nullable string
      required
      Description

      The postal code of the address.

      Example: 10024
    • Name
      state
      Type
      nullable string
      required
      Description

      The state/province/region of the address.

      Example: NY
    • Name
      user
      Type
      string
      required
      Description

      Unique identifier for the address user.

      Example: usr_0SNlurA049MEWV4OpCwsNyC9Kn2d
    • Name
      createdAt
      Type
      string
      required
      Description

      The time the address was created.

      Example: 2021-01-21T19:38:34Z
  • Name
    datacontenttype
    Type
    string
    required
    Description

    The RFC 2046 content-type.

    Example: application/json
    Default: application/json
  • 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.user.address.created.

  • 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": "userAddress",
    "id": "adr_0SNlurA049MEWV5ELDmnaqVXgTFT",
    "city": "New York City",
    "country": "US",
    "line1": "129 West 81st Street",
    "line2": "Apartment 5A",
    "postalCode": "10024",
    "state": "NY",
    "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d",
    "createdAt": "2021-01-21T19:38:34Z"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42Z",
  "type": "com.gigs.user.address.created",
  "version": "2024-08-29"
}