--- title: "Create a new event" method: POST path: "/events" tags: ["Endpoints"] --- # Create a new event `POST /events` This endpoint creates a new *eTrusted* event. **NB:** In compliance with [GDPR](https://gdpr.eu/tag/chapter-3), customers should be given the option to opt-in to receive review invitations from you. Therefore, create events using data of **only** customers who have opted-in. ## Headers - `Authorization` string, required ## Request body - EventRequest — This object represents the request payload for creating an *eTrusted* event. **NB:** In compliance with [GDPR](https://gdpr.eu/tag/chapter-3), customers should be given the option to opt-in to receive review invitations from you. Therefore, create events using data of **only** customers who have opted-in. - `type` string, required — The event type. It represents the touchpoint that triggered the event. You can only use an event type that exists in your *eTrusted* configuration.
Learn more about event types from our [help centre](https://help.etrusted.com/hc/en-gb/articles/360025746352-What-is-an-Event-#what-do-we-mean-by-transaction)
Also, check out the [event type](/reference/get-event-types-1) documentation to learn more about the event type API.
In any case please avoid setting the type to "checkout" as this is a reserved type. - `defaultLocale` string — The default [locale](/reference/locales) for this event. If set, the default locale determines the language of the invite and the questionnaire that are triggered by the event. If not set, the channel locale will be used instead. - `customer` object, required — The customer object includes all data of the customer who is invited to leave a review. - `firstName` string — First name of the customer. - `lastName` string — Last name of the customer. - `email` string, required — Email address of the customer. It must be a valid email address. - `address` string — Address of the customer. - `mobile` string — Mobile telephone number of the customer. The mobile number must have international format including `+` and country code. (e.g. `+49123456789`). - `reference` string — The customer's ID as a reference [UUID](/reference/uuid-prefixes. - `channel` object, required — This object holds information about the [channel](/reference/get-channels-by-token) associated with the event. - `id` string, required — The unique identifier of the channel. This can either be an *eTrusted* [UUID](/reference/uuid-prefixes)or an identifier from your own software eco-system. Please see [Channel IDs](/reference/channel-ids). - `type` 'user_defined' | 'etrusted' — This can be set to either `user_defined` if you defined the channel id yourself or `etrusted` if it was generated by the eTrusted system thus its in the format `chl-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx`. Please see [Channel IDs](/reference/channel-ids) for more. - `transaction` object, required — The event transaction holds a reference to the transaction, order, process etc. within your own system that triggers the event. - `reference` string, required — The transaction reference identifies your internal transaction, order, process etc. This string must be unique. For example, it can be an order or invoice number such as `order-12345`. - `date` string, date-time — The date and time when the transaction took place. It is a timestamp in the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) and [RFC 3339](https://tools.ietf.org/html/rfc3339) compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. Check the [glossary](/docs/glossory#iso-8601) for examples of valid datetime formats. - `estimatedDeliveryDate` string, date — The estimated date of the delivery. It is a date in the ISO 8601 and RFC3339 compliant format `yyyy-MM-dd`. Check the [glossary](/docs/glossory#iso-8601) for examples of valid datetime formats. - `products` object[] — This is a list of products. It contains the products that are associated with the event. It includes all data needed for product reviews for these products. - `gtin` string — The GTIN identifies the product globally. A GTIN can be an ISBN, an EAN, and much more. Refer to [gtin.info](https://www.gtin.info/) - `imageUrl` string — A link to a product image. *eTrusted* can display an image of the product to the customer who is writing a review. This makes it easier for customers to remember and recognize the product. - `name` string, required — The product name contains information about a product that is associated with the event (e.g. `Specialbrand T-Shirt White M`). - `mpn` string — The Manufacturer Part Number is an identifier for a product by the manufacturer if applicable. In some cases it can serve as a substitute for the GTIN. - `sku` string, required — The Stock Keeping Unit is a specific article number of the product, most often assigned by a specific retail shop as a scannable bar code. It lets the shops track movement of inventory. The SKU must be unique and usually consists of about 8 characters (e.g. `1234-TS-WH-M`). - `brand` string — The brand of the product (e.g. `specialbrand`). A product can only have one brand. - `url` string, required — A link to the product detail page in your online shop or public catalog (e.g. `http://www.specialbrandshop.com/article123-TS-WH-M/`). - `system` string, required — This is the system that issues the events API call. This way you can identify the source system that called the events API. - `systemVersion` string, required — This is the version of the source system. - `metadata` object — Add more information to your event via the metadata object. This may be anything that you want to track or evaluate. - `createdAt` string, date-time — The date and time when the event was created, in the ISO 8601 and RFC3339 compliant format `yyyy-MM-dd’T’HH:mm:ss.SSSZ`. Check the [glossary](/docs/glossory#iso-8601) for examples of valid datetime formats. ## Response `202` Accepted - EventPostResponse - `Message` string — The response message: "Your event (`evt-xxxxxxxx-yyyy-xxxx-yyyy-xxxxxxxxxxxx`) was accepted for processing". - `EventRef` string — The event reference UUID. ## Other responses - `400` — Bad Request - `401` — Unauthorized - `500` — Internal Server Error - `503` — Service Unavailable --- [API](https://skmtc.net/etrusted/apis/accounts-api.md) · [All operations](https://skmtc.net/etrusted/apis/accounts-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/etrusted/accounts-api/versions/649ef7dac98c/schema)