- Name
object
- Type
- string
- Description
Type of object is always
event
.
required- Name
id
- Type
- string
- Description
Unique identifier for the event.
Example:evt_0SNlurA049MEWV5gNTcQ5A07h3Ol
required- Name
data
- Type
- object
- Description
- Name
object
- Type
- string
- Description
Type of object is always
connectSession
.
required- Name
id
- Type
- string
- Description
Unique identifier for the Connect Session.
Example:csn_0SNlurA049MEWV1GWxpaE5D0t2D6
required- Name
callbackUrl
- Type
- nullable string
- Description
The URL to which the user will be redirected after the Connect Session is completed.
Example:https://example.com
required- Name
intent
- Type
- object
- Description
required- Name
url
- Type
- nullable string
- 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
required- Name
user
- Type
- nullable string
- Description
The unique identifier of the user that the session is for.
Example:usr_0SNlurA049MEWV4OpCwsNyC9Kn2d
required
required- Name
datacontenttype
- Type
- string
- Description
The RFC 2046 content-type.
Example:application/json
Default:application/json
required- 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
- Description
Unique identifier for the project where the event occurred.
Example:gigs
required- Name
source
- Type
- string
- Description
URI identifying the event source.
Example:https://api.gigs.com
Default:https://api.gigs.com
required- Name
specversion
- Type
- string
- Description
The CloudEvents spec version.
Example:1.0
Default:1.0
required- Name
time
- Type
- string
- Description
Time when the event occurred.
Example:2022-03-16T14:12:42Z
required- Name
type
- Type
- string
- Description
Type is always
com.gigs.connectSession.updated
.
required- Name
version
- Type
- string
- Description
API version used to serialize the data and the event itself.
Default:2024-08-29
required
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.updated",
"version": "2024-08-29"
}