com.gigs.connectSession.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 connectSession.

    • Name
      id
      Type
      string
      required
      Description

      Unique identifier for the Connect Session.

      Example: csn_0SNlurA049MEWV1GWxpaE5D0t2D6
    • Name
      callbackUrl
      Type
      nullable string
      required
      Description

      The URL to which the user will be redirected after the Connect Session is completed.

      Example: https://example.com
    • Name
      intent
      Type
      object
      required
      Description
    • Name
      url
      Type
      nullable string
      required
      Description

      The session URL. Redirect your users to this URL to take them to Connect. It is only present on all create responses or in the update responses that associate the session with a user. It should not be stored, logged or exposed to anyone other than the user.

      Example: https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp
    • Name
      user
      Type
      nullable string
      required
      Description

      The unique identifier of the user that the session is for.

      Example: usr_0SNlurA049MEWV4OpCwsNyC9Kn2d
  • 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.connectSession.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": "connectSession",
    "id": "csn_0SNlurA049MEWV1GWxpaE5D0t2D6",
    "callbackUrl": "https://example.com",
    "intent": {
      "cancelSubscription": {
        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
      },
      "changeSubscription": {
        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
      },
      "checkoutAddon": {
        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
      },
      "checkoutNewSubscription": {
        "device": "dev_0SNlurA049MEWV55CrA9qMvI2FVJ",
        "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
        "sim": "sim_0SNlurA049MEWV1BAAmWZULA4lf6",
        "imei": "492388841798923"
      },
      "completePorting": {
        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
      },
      "confirmPayment": {
        "payment": "pay_0SNlurA049MEWV2HRA0slWFuS8DV"
      },
      "resumeSubscription": {
        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
      },
      "type": "cancelSubscription",
      "viewEsimInstallation": {
        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
      },
      "viewSubscription": {
        "subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi"
      }
    },
    "url": "https://connect.gigs.com/checkout/entry?session=csn_0SNlurA049MEWV1GWxpaE5D0t2D6&token=lzODbEyaUQjVRAmalD4pdaq5Nkn1Lw0qTL6Rdsh7PwLVES6N7ImWxnCYbJA99AXp",
    "user": "usr_0SNlurA049MEWV4OpCwsNyC9Kn2d"
  },
  "datacontenttype": "application/json",
  "project": "gigs",
  "source": "https://api.gigs.com",
  "specversion": "1.0",
  "time": "2022-03-16T14:12:42Z",
  "type": "com.gigs.connectSession.created",
  "version": "2024-08-29"
}