Back to Home

Events API

The Events API is used to post events into The Wishlist such as an error so that our internal development team can analyse the issue. An example of an event is a failed API call after a number of attempts (determined by the developer).

The types of events are Entity (e.g. failed to post a customer), System (This is typically only used by TWC’s internal development team), Fault (any API faulure e.g. HTTP 502, 503) and Warning.

The Event typically includes the payload along with the event type/fault, and some key attributes like internal ID, or email.

THe Events API also has subscriptions, so the you can subscribe to certain events. This currently supports AWS SQS. The Wishlist will post to the configured destination when a change is made to the entity.

Index

---

• Events API
  • Representations
    • Order
  • REST Endpoints
    • Events Resource
      • Create Event
      • Find Events

Representations

All request and responses are JSON objects.

Order

entity_id - string - the id of the entity.

entity_name - string- the name of the entity.

base64_encoded_fault_json - string.

base64_encoded_payload_json - string- base64 encoded payload json.

additionalProp1 - string- key attribute values like correlationId

additionalProp2 - string- key attribute values like reference id

additionalProp3 - string-.key attribute value like time stamp- the time error occurred

operation - string- operation type like BULK_CREATE or BULK_UPDATE or CREATE or DELETE or READ or UPDATE.

event_source - [ CUSTOMER, INVENTORY_LEVEL, INVENTORY_LOCATION, ORDER, PRICE, PRODUCT, VARIANT_PRODUCT, WISHLIST ]

id - unique id of the event.

event_type - string - type of event like FAULT

REST Endpoints

Events Resource

Create Event

For the creation of a new Event resource with unique id.

Method: POST

Endpoint: ​​​/api/v1/events

OAuth 2.0 Scopes: Tenant authentication - authentication

Request Headers :

Key	Value
Content-Type	application/json
X-TWC-Tenant	{Tenant Name}

Request :

{
  "entity_id": "string",
  "event_payload": {
    "base64_encoded_payload_json": "ewoiaWQiOiIxMiIsCiJyZWZlcmVuY2UiOiIxMjEyMyIKfQ==",
    "key_attributes": {
      "correlationId": "123123123-123123-123123123",
      "referenceId": "referenceId",
      "timestamp": "time at error occured",
      "additionalKey1": "value1",
      "additionalKey2": "value2",
      "additionalKeyN": "valueN"
    },
    "operation": "BULK_CREATE or BULK_UPDATE or CREATE or DELETE or READ or UPDATE",
    "base64_encoded_fault_json": "eyJpZCI6IjEyXCJ9"
  },
  "event_source": "APPLICATION",
  "event_type": "FAULT"
}'

Response - 201 (Created)

{
  "entity_id": "string",
  "entity_name": "string",
  "event_payload": {
    "base64_encoded_fault_json": "string",
    "base64_encoded_payload_json": "string",
    "entity_id": "string",
    "key_attributes": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "operation": "BULK_CREATE"
  },
  "event_source": "APPLICATION",
  "event_type": "ENTITY_EVENT",
  "id": "string"
}

HTTP Status Code:

- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request 
- 401 Unauthorised
- 403 Forbidden 
- 404 Not Found
- 405 Invalid input

Find Events

To find event by id. Id is passed as a path param.

Method: GET

Endpoint: ​/api/v1/events/{eventId}

OAuth 2.0 Scopes: Tenant authentication - authentication

Request Headers :

Key	Value
Content-Type	application/json
X-TWC-Tenant	{Tenant Name}

Request Parameters: eventId : id

Response - 200 (OK)

{
  "entity_id": "string",
  "entity_name": "string",
  "event_payload": {
    "base64_encoded_fault_json": "string",
    "base64_encoded_payload_json": "string",
    "entity_id": "string",
    "key_attributes": {
      "additionalProp1": "string",
      "additionalProp2": "string",
      "additionalProp3": "string"
    },
    "operation": "BULK_CREATE"
  },
  "event_source": "APPLICATION",
  "event_type": "ENTITY_EVENT",
  "id": "string"
}

HTTP Status Code:

- 200 OK
- 201 Created
- 204 Deleted
- 400 Bad request 
- 401 Unauthorised
- 403 Forbidden 
- 404 Not Found
- 405 Invalid input

---

Back to Top

Back to Home