How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

VTEX Events API

The Events API from VTEX — 1 operation(s) for events.

VTEX Events API is one of 142 APIs that VTEX publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Event. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 1 operation across 1 path, and defines 9 schemas. It is described by OpenAPI 3.0.0, at version 1.0.

Requests are made against a single base URL, https://{providerApiEndpoint}.

1 operations 1 paths 9 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0
Base URL
https://{providerApiEndpoint}
Authentication
API Key
Resource Areas
1

Authentication & Security 1

VTEX Events API declares 1 security scheme for authenticating requests. An API key is passed in the header as VtexIdclientAutCookie (VtexIdclientAutCookie).

  • VtexIdclientAutCookie — [User token](https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens), valid for 24 hours.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Events 1
POST
/event
VTex Save events
1 param body → 204

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are Query (9 properties), Click (8 properties), PageConfirmation (5 properties), SessionPing (4 properties). Each schema is shown below with its type and property counts.

UserIdentification
object
2 properties
Query
object
Sends a query event every time the shopper makes a full-text search.
9 properties 7 required
PageConfirmation
object
Sends a confirmation informing the products that were bought.
5 properties 5 required
OrderProduct
object
Product information.
3 properties 3 required
PageCart
object
Sends an event every time the shopper enters the cart page. Each interaction should include all products inside the shopping cart at that time. In case a produ…
4 properties 4 required
PageEmptyCart
object
Sends an event if there are no products in the shopping cart at that time.
4 properties 4 required
SessionPing
object
Sends an ACK to the API to renew the session server-side. It should be sent every 1 minute.
4 properties 4 required
Click
object
Sends an event every time a shopper clicks on a product from a search page.
8 properties 6 required
CartProduct
object
Product information.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vtex-events-api-openapi.yml Raw ↑

Other APIs VTEX publishes across the network.

VTEX Account API
VTEX Addresses API
VTEX Anti-Fraud Flow API
VTEX App Keys API
VTEX Attachment API
VTEX Authentication API
VTEX Autocomplete API
VTEX Brand API
VTEX Bulk Import API
VTEX Carriers API
VTEX Cart Attachments API
VTEX Category API
Where this information came from

This is an independent, third-party profile of VTEX Events API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.