- 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
portOutCredentials
.
required- Name
accountNumber
- Type
- string
- Description
The account number on the service provider.
Example:123456789
required- Name
accountPin
- Type
- nullable string
- Description
The account pin on the service provider. This value will always be null in all events.
Example:1234
required- Name
subscription
- Type
- string
- Description
Unique identifier of the subscription affected.
Example:sub_0SNlurA049MEWV2gSfSxi00xlPIi
required- Name
expiresAt
- Type
- string
- Description
Time when the port-out credentials expire and won't be valid anymore.
Example:2022-02-21T19:38:34Z
required
required- Name
datacontenttype
- Type
- string
- Description
The RFC 2046 content-type.
Example:application/json
Default:application/json
required- 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.portOutCredentials.issued
.
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": "portOutCredentials",
"accountNumber": "123456789",
"accountPin": "1234",
"subscription": "sub_0SNlurA049MEWV2gSfSxi00xlPIi",
"expiresAt": "2022-02-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.portOutCredentials.issued",
"version": "2024-08-29"
}