Fire an event

POST

https://core.shopimind.com/v1/events/trigger/{code_name}

Fires an instance of the event type identified by code_name. The body must include either a contact (matched by id, email, or phone) or a visitor (matched by id); at least one is required. metaData and customData are validated against the event type's properties schema declared at createEvent time. Workflow execution is asynchronous.

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_-]+$"

Path Parameters

code_name*

Code name of the event to trigger

Required

Request Body

application/json

{

  

"contact": {

  

  

"id": 1,

  

  

"email": "mail@gmail.com",

  

  

"phone": "+00000000000000",

  

  

"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": {

  

  

"id": 0,

  

  

"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": {

  

},

  

"customData": {

  

}

}

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/trigger/{code_name}

Playground

Headers

spm-api-key*

Variables

Key

Value

code_name*

Body

Samples

Fire an event Fires an instance of the event type identified by code_name. The body must include either a contact (matched by id, email, or phone) or a visitor (matched by id); at least one is required. metaData and customData are validated against the event type's properties schema declared at createEvent time. Workflow execution is asynchronous. POST /v1/events/trigger/{code_name} triggerEvent Events spm-api-key [Authentication] Required API key, in the form {prefix}.{secret}. code_name Code name of the event to trigger Client error - Invalid request or authentication issues Server error - Internal processing failure