Jirafe Events

Name: Jirafe Events API
Brand: Jirafe Events
Availability: InStock

★ Only Publicly Available OpenAPI DocumentAnalyticsProduct Analyticsoauth26 EndpointsREST

For Agents

Send e-commerce events (cart, product, category, customer, order) into Jirafe for analytics, individually or via the batch endpoint.

Install Jentic One Beta

Connect the Jirafe Events to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Jirafe Events, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Jirafe Events API.

Send cart-add, cart-remove, and cart-checkout events to /{siteId}/cart

Send product-view events with SKU and price metadata to /{siteId}/product

Send category-browse events to /{siteId}/category for funnel analysis

GET STARTED

Start building with Jirafe Events API

Explore with Jentic

View OpenAPI Document

Use Cases

Patterns agents use Jirafe Events API for, with concrete tasks.

★ Storefront Event Tracking

An e-commerce storefront sends cart, product, and order events to Jirafe Events from server-side hooks so the analytics platform can build funnels (visit -> product view -> cart -> checkout -> order). Server-side ingest is more reliable than client beacons because it survives ad blockers and tab closures.

POST a cart event to /{siteId}/cart with action=add, productId=SKU123, quantity=2, and price=29.99 from the storefront's add-to-cart hook.

Backfill via Batch Ingest

When migrating to Jirafe or replaying historical orders, sending events one-at-a-time is rate-limit-prone and slow. The /{siteId}/batch endpoint accepts an array of mixed event types in a single request, suitable for nightly replays of the day's orders or one-off historical backfills of months of data.

POST a JSON array of order events to /{siteId}/batch covering yesterday's orders, then verify the response confirms each event was accepted.

Customer Lifecycle Analytics

Combining customer events (signup, login) with downstream cart and order events lets Jirafe compute time-to-first-purchase, repeat-rate, and churn signals. Sending each lifecycle moment to the matching event endpoint is the prerequisite for any of these reports inside Jirafe's dashboard.

On user registration POST a customer signup event to /{siteId}/customer; on first checkout POST an order event to /{siteId}/order with the same customerId.

AI Agent Integration via Jentic

An e-commerce agent uses Jentic to discover Jirafe ingest operations by intent. The agent searches for 'send a cart event to analytics' and Jentic returns the /{siteId}/cart operation, so the agent posts the event without reading Jirafe docs. The OAuth token stays in the Jentic vault.

Search Jentic for 'send an order event to Jirafe', load the POST /{siteId}/order schema, and execute it with the order's line items and totals.

Key Endpoints

6 endpoints — this is the primary jirafe events api for the jirafe e-commerce analytics platform.

METHOD

PATH

DESCRIPTION

POST

/{siteId}/cart

Send a cart event

POST

/{siteId}/product

Send a product event

POST

/{siteId}/order

Send an order event

POST

/{siteId}/customer

Send a customer event

POST

/{siteId}/batch

Submit a batch of events

POST

/{siteId}/cart

Send a cart event

POST

/{siteId}/product

Send a product event

POST

/{siteId}/order

Send an order event

POST

/{siteId}/customer

Send a customer event

POST

/{siteId}/batch

Submit a batch of events

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Jirafe's OAuth tokens are stored encrypted in the Jentic vault and injected at execution time. Raw tokens never enter the agent's prompt context or logs.

Intent-based discovery

Agents search Jentic with intents like 'send a cart event to analytics' and Jentic returns the matching Jirafe Events endpoint with its body schema.

Time to first call

Direct Jirafe Events integration: 1-2 days for OAuth, batching, and retry handling. Through Jentic: under 1 hour — search, load schema, execute.

FAQs

Specific to using Jirafe Events API through Jentic.

What authentication does Jirafe Events use?

OAuth 2.0 — both authorization-code and implicit flows are declared in the spec. Send the resulting access token as a Bearer token on each event POST. Through Jentic the OAuth flow is brokered and tokens are kept in the vault rather than the agent context.

Can I send a batch of events in one request to Jirafe?

Yes. POST a JSON array of events to /{siteId}/batch. This is the right choice for backfills and any case where you'd otherwise rate-limit yourself by sending many single-event requests in a tight loop.

What are the rate limits for Jirafe Events?

Jirafe does not publish a fixed limit in the spec; the documented guidance is to use /{siteId}/batch for high-volume ingest. If single-event POSTs return 429, switch to batch and retry with exponential backoff.

How do I send a product-view event through Jentic?

Run pip install jentic, search for 'send a product view event to analytics', then load and execute POST /{siteId}/product with the productId, name, and price. Jentic injects the OAuth token automatically.

Do I need a separate site ID for each storefront?

Yes — every event endpoint is scoped by the {siteId} path parameter, which corresponds to a Jirafe site (typically one per storefront or brand). Provision sites in the Jirafe dashboard before sending events.

Is Jirafe Events free?

Jirafe pricing is plan-based and not exposed by the API itself. Existing Jirafe customers should consult their account; new evaluators should contact Jirafe to confirm the current commercial terms.

Jirafe Events

Connect the Jirafe Events to your agent

Capabilities

Start building with Jirafe Events API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs