com.gigs.portOutCredentials.issued

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

    • Name
      accountNumber
      Type
      string
      required
      Description

      The account number on the service provider.

      Example: 123456789
    • Name
      accountPin
      Type
      nullable string
      required
      Description

      The account pin on the service provider. This value will always be null in all events.

      Example: 1234
    • Name
      subscription
      Type
      string
      required
      Description

      Unique identifier of the subscription affected.

      Example: sub_0SNlurA049MEWV2gSfSxi00xlPIi
    • Name
      expiresAt
      Type
      string
      required
      Description

      Time when the port-out credentials expire and won't be valid anymore.

      Example: 2022-02-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.portOutCredentials.issued.

  • 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": "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"
}