Jump to

• Request
• Response

Create an Event Type

post

/ic/api/integration/v1/eventTypes

An event type describes the schema or structure of data contained in an event. This API function creates an event type. The request body must contain:

• name: Defines the name of the event type.
• code: Defines the code that is used as the unique identifier for the event type.
• description: Describes the event type.
• schema type: The type of schema associated with the event type. For example: json
• schema: The schema associated with the event type.

If the resource creation is successful, the response header contains the Location header that includes the location URL for the new resource created.

Request

Query Parameters

• integrationInstance(required): string
  This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.

Supported Media Types

• application/json;charset=utf-8

Request Body - application/json;charset=utf-8 ()

Root Schema : schema

Type: object

Show Source

• code: string
  Event type code
• description: string
  Event type description
• name: string
  Event type name
• schema: string
  Schema associated with the event type.
• schema-type: string
  Type of schema associated with the event type. For example: json

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"Event type name"
        },
        "description":{
            "type":"string",
            "description":"Event type description"
        },
        "code":{
            "type":"string",
            "description":"Event type code"
        },
        "schema-type":{
            "type":"string",
            "description":"Type of schema associated with the event type. For example: json"
        },
        "schema":{
            "type":"string",
            "description":"Schema associated with the event type."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

400 Response

Bad request, missing required data

500 Response

Server error

Back to Top