Post Nested Event

POST 
/v1/INCROWD/events

Post Nested Event

Request

Header Parameters

Accept-Language string
Example: en-GB
X-Real-IP string
Example: 203.0.113.195
X-APP-ID string
Example: android
X-REALM string
Example: incrowd
X-API-KEY string
Example: pbrGJOj825G3EcZIIr3Kcpc4PkHAVCUT

application/json

Body

object

Responses

200

OK

Response Headers

• Content-Type

  string

• Content-Length

  integer

• Connection

  string

• Date

  string

• Vary

  string

• X-Cache

  string

• Via

  string

• X-Amz-Cf-Pop

  string

• X-Amz-Cf-Id

  string

application/json

Schema

Schema

object

Example (from schema)

{}

Example

{
  "status": "success",
  "metadata": {
    "createdAt": "2024-02-23T10:04:20.82314175Z"
  }
}

400

Bad Request

Response Headers

• Content-Type

  string

• Content-Length

  integer

• Connection

  string

• Date

  string

• X-Cache

  string

• Via

  string

• X-Amz-Cf-Pop

  string

• X-Amz-Cf-Id

  string

application/json

Schema

Schema

object

Example (from schema)

{}

example-0

Missing source system ID

{
  "status": "fail",
  "error": {
    "code": "bad_request",
    "domain": "global"
  },
  "message": "Key: 'eventPayload.SourceSystemID' Error:Field validation for 'SourceSystemID' failed on the 'required' tag",
  "metadata": {
    "createdAt": "2021-03-03T12:53:42.577Z"
  }
}

example-1

Missing Event ID

{
  "status": "fail",
  "error": {
    "code": "bad_request",
    "domain": "global"
  },
  "message": "Key: 'eventPayload.EventID' Error:Field validation for 'EventID' failed on the 'uuid5_rfc4122' tag",
  "metadata": {
    "createdAt": "2021-03-03T12:53:15.351Z"
  }
}

example-2

Invalid event ID format (uuid5_rfc4122)

{
  "status": "fail",
  "error": {
    "code": "bad_request",
    "domain": "global"
  },
  "message": "Key: 'eventPayload.EventID' Error:Field validation for 'EventID' failed on the 'uuid5_rfc4122' tag",
  "metadata": {
    "createdAt": "2021-03-03T12:54:20.263Z"
  }
}

example-3

Missing header

{
  "status": "fail",
  "error": {
    "code": "bad_request",
    "domain": "global"
  },
  "data": {
    "X-APP-ID": "Missing Header"
  },
  "message": "Missing Header",
  "metadata": {
    "createdAt": "2021-03-03T12:53:02.276Z"
  }
}

example-4

Invalid event type

{
  "status": "fail",
  "error": {
    "code": "bad_request",
    "domain": "global"
  },
  "message": "Key: 'eventPayload.EventType' Error:Field validation for 'EventType' failed on the 'oneof' tag",
  "metadata": {
    "createdAt": "2021-03-03T12:54:07.852Z"
  }
}

example-5

Invalid source system

{
  "status": "fail",
  "error": {
    "code": "bad_request",
    "domain": "global"
  },
  "message": "Key: 'eventPayload.SourceSystem' Error:Field validation for 'SourceSystem' failed on the 'oneof' tag",
  "metadata": {
    "createdAt": "2021-03-03T12:53:30.219Z"
  }
}

401

Unauthorized

Response Headers

• Content-Type

  string

• Content-Length

  integer

• Connection

  string

• Date

  string

• X-Cache

  string

• Via

  string

• X-Amz-Cf-Pop

  string

• X-Amz-Cf-Id

  string

application/json

Schema

Schema

object

Example (from schema)

{}

Example

{
  "status": "fail",
  "error": {
    "code": "unauthorized",
    "domain": "global"
  },
  "message": "Unauthorized",
  "metadata": {
    "createdAt": "2021-03-03T12:52:49.595Z"
  }
}

Loading...