Generate events v1

post deprecated

https://yespo.io/api/v1/event

The method is used for generating events in the account to be used for starting a workflow or being taken into account for segmentation.
Max. size of content for events sent in the request body is 20 kB.
To learn more, read Order management via events.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

eventTypeKey

string

required

Event type ID key. If no event type exists with this key, a new event is created.
All characters are allowed except < ; ’ \ / | " ` ' ^ ? ! , >
Max length: 100 symbols

keyValue

string

Event key. Determines event uniqueness.
The key must contain a unique value for each contact (for example, email, phone number, external contact id, etc.)
If this parameter is not set, params must contain one of the following contact identifiers:
- contactId
- externalCustomerId
- email
- phone
- pushToken: web or mobile
All characters are allowed except the following ones < ; ’ \ / | " ` ' ^ ? ! , >
Max length: 300 symbols

params

array of objects

List of event parameters represented as an array of "key" - "value" pairs. The parameter keys are arbitrary.
Used in campaigns and for creating dynamic content in messages.

params

Response

200

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here!