Register an event type

POST

https://core.shopimind.com/v1/events

Registers a new external event type that the integration can later fire via triggerEvent. The event declaration defines its name, machine code_name (used in triggerEvent's URL), and a properties schema describing the contact, visitor, custom-data and metadata payloads accepted at trigger time. Distinct from triggerEvent: this endpoint defines the event type; triggerEvent fires an instance.

Parameters

Header Parameters

spm-api-key*

[Authentication] Required API key, in the form {prefix}.{secret}.

Type

string

Required

Example"a1b2c3d4.xK9pR2mVn6QwErTyUiOpAsDfGhJkLzXcVbNmQwErTyU"

Pattern

"^[a-zA-Z0-9]{8}\\.[A-Za-z0-9_-]+$"

Request Body

application/json

{

  

"name": "Order Created",

  

"code_name": "order_create",

  

"properties": [

  

  

{

  

  

  

"contact": {

  

  

  

  

"customData": [

  

  

  

  

  

{

  

  

  

  

  

  

"name": "id",

  

  

  

  

  

  

"type": "number",

  

  

  

  

  

  

"description": "Unique contact identifier",

  

  

  

  

  

  

"required": true,

  

  

  

  

  

  

"primary": true,

  

  

  

  

  

  

"updateData": true,

  

  

  

  

  

  

"label": "metadata.order_id",

  

  

  

  

  

  

"targetSchemaType": "system",

  

  

  

  

  

  

"targetSchema": "orders",

  

  

  

  

  

  

"targetField": "order_id"

  

  

  

  

  

}

  

  

  

  

]

  

  

  

},

  

  

  

"visitor": {

  

  

  

  

"customData": [

  

  

  

  

  

{

  

  

  

  

  

  

"name": "id",

  

  

  

  

  

  

"type": "number",

  

  

  

  

  

  

"description": "Unique contact identifier",

  

  

  

  

  

  

"required": true,

  

  

  

  

  

  

"primary": true,

  

  

  

  

  

  

"updateData": true,

  

  

  

  

  

  

"label": "metadata.order_id",

  

  

  

  

  

  

"targetSchemaType": "system",

  

  

  

  

  

  

"targetSchema": "orders",

  

  

  

  

  

  

"targetField": "order_id"

  

  

  

  

  

}

  

  

  

  

]

  

  

  

},

  

  

  

"customData": [

  

  

  

  

{

  

  

  

  

  

"name": "id",

  

  

  

  

  

"type": "number",

  

  

  

  

  

"description": "Unique contact identifier",

  

  

  

  

  

"required": true,

  

  

  

  

  

"primary": true,

  

  

  

  

  

"updateData": true,

  

  

  

  

  

"label": "metadata.order_id",

  

  

  

  

  

"targetSchemaType": "system",

  

  

  

  

  

"targetSchema": "orders",

  

  

  

  

  

"targetField": "order_id"

  

  

  

  

}

  

  

  

],

  

  

  

"metaData": [

  

  

  

  

{

  

  

  

  

  

"name": "id",

  

  

  

  

  

"type": "number",

  

  

  

  

  

"description": "Unique contact identifier",

  

  

  

  

  

"required": true,

  

  

  

  

  

"primary": true,

  

  

  

  

  

"updateData": true,

  

  

  

  

  

"label": "metadata.order_id",

  

  

  

  

  

"targetSchemaType": "system",

  

  

  

  

  

"targetSchema": "orders",

  

  

  

  

  

"targetField": "order_id"

  

  

  

  

}

  

  

  

],

  

  

  

"params": {

  

  

  

  

"additionalProperties": {

  

  

  

  

}

  

  

  

}

  

  

}

  

]

}

Responses

Client error - Invalid request or authentication issues

Content-Type

application/json

{

  

"statusCode": 400,

  

"message": "Invalid request parameters",

  

"error": "Bad Request"

}

POST

https://core.shopimind.com/v1/events

Playground

Headers

spm-api-key*

Body

Samples

Register an event type Registers a new external event type that the integration can later fire via triggerEvent. The event declaration defines its name, machine code_name (used in triggerEvent's URL), and a properties schema describing the contact, visitor, custom-data and metadata payloads accepted at trigger time. Distinct from triggerEvent: this endpoint defines the event type; triggerEvent fires an instance. POST /v1/events createEvent Events spm-api-key [Authentication] Required API key, in the form {prefix}.{secret}. Client error - Invalid request or authentication issues Server error - Internal processing failure