Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Talon.One Events API

Integration API - submit custom events that trigger rules.

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

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

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

Requests are made against a single base URL, https://yourbaseurl.talon.one.

1 operations 1 paths 4 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://yourbaseurl.talon.one
Authentication
API Key, API Key
Contact
Resource Areas
1

Authentication & Security 2

Talon.One Events API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (integrationKey). An API key is passed in the header as Authorization (managementKey). By default, every request must be authenticated.

  • integrationKey — Integration API key with the ApiKey-v1 prefix, e.g. header "Authorization: ApiKey-v1 ".
  • managementKey — Management API key with the ManagementKey-v1 prefix, e.g. header "Authorization: ManagementKey-v1 ".

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

Integration API - submit custom events that trigger rules.

POST
/v2/events
Track event
trackEventV2 body → 200

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are CustomerSession (8 properties), CartItem (5 properties), Effect (4 properties), IntegrationStateV2 (3 properties). Each schema is shown below with its type and property counts.

CustomerSession
object
A customer session evaluated against the Application's campaigns.
8 properties
IntegrationStateV2
object
The evaluated session plus the effects to apply in the caller.
3 properties
Effect
object
A single effect returned by the rules engine (e.g. setDiscount, acceptCoupon, addLoyaltyPoints).
4 properties
CartItem
object
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

talon-one-events-api-openapi.yml Raw ↑

Other APIs Talon.One publishes across the network.

Talon.One Account API
Talon.One Applications API
Talon.One Attributes API
Talon.One Audiences API
Talon.One Campaigns API
Talon.One Collections API
Talon.One Coupons API
Talon.One Customer Profiles API
Talon.One Customer Sessions API
Talon.One Exports API
Talon.One Loyalty API
Talon.One Referrals API