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

    • Name
      id
      Type
      string
      required
      Description

      Unique identifier for the API key.

      Example: apk_0SNlurA049MEWV4wRq2ql6SYZxiY
    • Name
      name
      Type
      string
      required
      Description

      Human readable name describing what the API key is used for.

      Example: My first Gigs API integration
    • Name
      token
      Type
      string
      required
      Description

      The bearer token to be used in HTTP Authorization. The full token is only available in the create response. In all other responses a redacted token will be returned, as we do not store the full token ourselves.

      Example: gpk_2W4IoEFH••••
    • Name
      createdAt
      Type
      string
      required
      Description

      Time when the API key was created.

      Example: 2022-02-14T19:38:34Z
    • Name
      expiresAt
      Type
      nullable string
      required
      Description

      Time when the API key expires 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.apiKey.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": "apiKey",
    "id": "apk_0SNlurA049MEWV4wRq2ql6SYZxiY",
    "name": "My first Gigs API integration",
    "token": "gpk_2W4IoEFH••••",
    "createdAt": "2022-02-14T19:38:34Z",
    "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.apiKey.created",
  "version": "2024-08-29"
}