inlytips API Reference

Management API

https://intelpush-mgmt-api.jmm70.workers.dev

Cloudflare Worker. CRUD operations on MongoDB collections for the administration dashboard. Manages cardholders, notifications, stats, prompts, charts and logos.

GET /cardholders List cardholders with search and pagination

Query params

Param	Type		Description
first	string	optional	Case-insensitive partial match by first name
last	string	optional	Case-insensitive partial match by last name
page	number	optional	Page number. Default: 1
limit	number	optional	Results per page. Default: 50. Max: 100

Response 200

"data": [{ "_id": "...", "first": "Lauren", "last": "Anderson", "cc_num": "...", "language": "EN" }],
"total": 1000, "page": 1, "limit": 50, "pages": 20

Sorted by last name ascending, then first name ascending.

GET /notifications Notifications for a cardholder filtered by date range

Query params

Param	Type		Description
cc_num	string	required	Credit card number
date_from	string	optional	Format: "YYYY-MM-DD" or "YYYY-MM-DD HH:MM:SS"
date_to	string	optional	Format: "YYYY-MM-DD" or "YYYY-MM-DD HH:MM:SS"
page	number	optional	Page number. Default: 1
limit	number	optional	Results per page. Default: 50. Max: 100

Response 200

{
  "data": [{
    "cc_num": "...", "first_name": "Keith", "last_name": "Sanders",
    "trans_date_trans_time": "2026-04-18 18:17:17",
    "title": "...", "body": "...", "language_code": "en",
    "has_body": false, "has_media": false, "feedback": ""
  }],
  "total": 76, "page": 1, "limit": 50, "pages": 2
}

GET /stats/transactions KPIs and daily series for transactions

Response 200

{
  "last_day": { "date": "2026-04-18", "transactions": 150, "amount": 12345.67 },
  "prev_day": { "date": "2026-04-17", "transactions": 132, "amount": 11200.00 },
  "transactions_by_day": [{ "date": "...", "count": 150 }],
  "amount_by_day":      [{ "date": "...", "amount": 12345.67 }]
}

Arrays sorted by date ascending (ready for charts). last_day / prev_day refer to the most recent days with actual activity.

GET /stats/notifications KPIs and daily series for notifications

Response 200

{
  "last_day": { "date": "2026-04-18", "notifications": 45 },
  "prev_day": { "date": "2026-04-17", "notifications": 38 },
  "notifications_by_day": [{ "date": "...", "count": 45 }]
}

GET /prompts List prompts from the AI library

Query params

Param	Type		Description
active	boolean	optional	true = active only · false = inactive only

Response 200

{ "data": [{ "code": 1, "insight_type": "total_spend_trend", "category": null, "template": "...", "active": true, "created_at": "2026-04-21" }] }

GET /prompts/:code Get prompt detail by code

POST /prompts Create a new prompt

Body JSON

Field	Type		Description
code	number	required	Unique identifier
insight_type	string	required	e.g. total_spend_trend
template	string	required	Prompt text with wildcards
category	string	optional	Category. Default: null

Responses

201 { "created": true, "code": 1 }

409 { "error": "Prompt code X already exists" }

PUT /prompts/:code Edit insight_type, category or template

PATCH /prompts/:code/status Enable or disable a prompt

{ "active": true }

200 { "updated": true, "active": true }

GET /charts List charts from the visual library

Query params

Param	Type		Description
active	boolean	optional	true = active only · false = inactive only

Response 200

{ "data": [{ "code": 1, "type": "big_number", "title_en": "Monthly summary", "active": true, "preview_url": "..." }] }

GET /charts/:code Get chart detail by code

POST /charts Create a new chart

Body JSON

Field	Type
code	number	required
type	string	required
title_en	string	required
subtitle_en	string	required
title_ca / title_es / subtitle_ca / subtitle_es / description_en	string	optional

PUT /charts/:code Edit chart fields

PATCH /charts/:code/status Enable or disable a chart

{ "active": false }

GET /logos List corporate logos

Query params

Param	Type		Description
active	boolean	optional	true = active logo · false = inactive

Response 200

{ "data": [{ "code": 1, "name": "intelpush-base", "description": "Primary logo", "r2_url": "logos/intelpush-base.png", "created_at": "2026-05-01", "active": true }] }

Only one logo can be active at a time. r2_url is null until the file is uploaded.

GET /logos/:code Get logo detail by code

POST /logos Create logo entry — metadata only (step 1 of 2)

Body JSON

Field	Type		Description
code	number	required	Unique identifier
name	string	required	R2 filename without extension, no spaces
description	string	required	e.g. "Women's Day 2026"

Logo is created inactive. Upload the file in step 2 via POST /logos/:code/upload.

POST /logos/:code/upload Upload image file to R2 (step 2 of 2)

Body multipart/form-data

Field	Type		Description
file	File	required	Image file (PNG, SVG, JPEG…)

Response 200

{ "uploaded": true, "r2_url": "logos/intelpush-base.png" }

File is stored in R2 as logos/{name}.{ext} in the intelpush-images bucket.

PATCH /logos/:code/status Activate a logo (deactivates all others)

{ "active": true }

When active: true, all other logos are automatically set to false. This is the only mechanism to change the active logo.

PUT /logos/:code Edit name or description

Field	Type		Description
code	string	required	Unique identifier, lowercase with underscores (e.g. `subscriptions`)
label.en	string	required	English label
label.ca	string	optional	Catalan label
label.es	string	optional	Spanish label

Field	Type		Description
label	object	required	Object with `en`, `ca`, `es` string keys

Insights

https://intelpush-mgmt-api.jmm70.workers.dev

Notification campaign configuration. Default campaigns apply to all users when no specific campaign matches. Specific campaigns apply conditions on category, gender and age range.

GET /insights/default List default campaigns

Query params

Param	Type		Description
active	boolean	optional	true = active only · false = inactive only

Response 200

{ "data": [{ "code": 1, "name": "Text enrichment tip", "mode": "consecutive_global",
  "body_enrichment": true, "tip": true, "prompt_code": null,
  "chart": false, "chart_code": null,
  "interactivity": true, "pwa_btn1": "Irrelevant", "pwa_btn2": "Useful",
  "native_btn": "Irrelevant", "native_inline": "Feelings?",
  "active": true, "created_at": "2026-05-03" }] }

Only one default campaign can be active at a time.

POST /insights/default Create a default campaign

Body JSON

Field	Type		Description
code	number	required	Unique identifier
name	string	required
mode	string	required	fixed · random · consecutive_global · consecutive_per_client
body_enrichment	boolean	optional	Enables tip and prompt_code. Default: false
tip	boolean	optional	Only if body_enrichment = true
prompt_code	number	optional	Only if body_enrichment = true
chart	boolean	optional	Enables chart_code. Default: false
chart_code	number	optional	Only if chart = true
interactivity	boolean	optional	Enables button fields. Default: false
pwa_btn1 / pwa_btn2	string	optional	Only if interactivity = true
native_btn / native_inline	string	optional	Only if interactivity = true

201 { "created": true, "code": 1 }

PUT /insights/default/:code Edit a default campaign

PATCH /insights/default/:code/status Activate or deactivate (exclusive)

{ "active": true }

When active: true, all other default campaigns are automatically deactivated.

GET /insights/campaigns List specific campaigns

Query params

Param	Type		Description
active	boolean	optional	true = active only · false = inactive only
category	string	optional	Filter campaigns that include this category (or "all")

Response 200 — conditions object

"conditions": {
  "categories": ["food_dining"],   // ["all"] or specific list
  "gender":     "F",              // "all" | "M" | "F"
  "age_min":    25,
  "age_max":    45
}

Multiple campaigns can be active simultaneously.

POST /insights/campaigns Create a specific campaign

PUT /insights/campaigns/:code Edit a specific campaign

PATCH /insights/campaigns/:code/status Activate or deactivate

{ "active": true }

Multiple specific campaigns can be active at the same time.

AI Worker

https://intelpush-worker.jmm70.workers.dev

Cloudflare Worker. Receives transaction data, queries the last 3 months of history from MongoDB and generates a personalised insight via Mistral AI.

POST / Generate notification insight

Body JSON

Field	Type		Description
cc_num	number	required	Identifies the user in MongoDB
first_name	string	required	Used in the Mistral prompt
language_code	string	required	e.g. "en", "ca", "es"
amount	number	required	Transaction amount
merchant	string	required	POS chains: format "Brand / address"
category	string	required	See categories table below
prompt_code	number	optional	Prompt template to use (1–9). Default: 1
include_advice	boolean	optional	If true, Mistral appends a concrete actionable tip. Default: false
max_chars	number	optional	Target character limit for the generated text. Default: 240. Pass 100 when a chart is shown alongside the notification so Mistral generates a telegraphic phrase that fits.

Available categories

entertainment · food_dining · gas_transport · grocery_pos · health_fitness · home
kids_pets · misc_net · misc_pos · grocery_net · shopping_net · personal_care · shopping_pos · travel

Response 200

{
  "notification": "You've spent 20% more on food this month...",
  "prompt_code": 3,
  "context": {
    "total_spend_m0": 1234.56, "total_spend_m1": 980.00, "total_spend_m2": 1100.00,
    "category_spend_m0": 200.00, "top_brand_m0": { "brand": "Shell", "total": 80.00 },
    "category_dist_m0": [{ "category": "food_dining", "pct": 35 }]
  }
}

If there is not enough history, returns { "notification": null, "reason": "insufficient_data" }

Image Worker

https://intelpush-image-worker.jmm70.workers.dev

Cloudflare Worker. Generates PNG charts (600×300 px) from MongoDB data and stores them in R2. Titles are resolved from the charts collection.

POST /chart Generate a chart by code (main endpoint)

Body JSON

Field	Type		Description
chart_code	number	required	Numeric code 1–9
user_id	string	conditional	cc_num. Required only for chart_code 5
lang	string	optional	"en" \| "ca" \| "es". Default: "en"

Response 200

{ "url": "https://intelpush-image-worker.jmm70.workers.dev/images/<uuid>.png", "chart_code": 6, "chart_type": "donut" }

Chart library

Code	type	title_en	user_id
1	big_number	Monthly summary	—
2	monthly_bars	Monthly spend	—
3	monthly_bars_ops	Spend & transactions	—
4	sparkline	Category trend	—
5	category_spend	Top categories	✓ required
6	donut	Spend by category	—
7	ranking	Category ranking	—
8	top_merchants	Top merchants	—
9	single_bar	Category vs last month	—

GET /images/:key Serve a generated image from R2

GET /library/:key Serve a static chart preview

Key format: chart_{code}.png (e.g. chart_6.png). Cache-Control: 24 hours. Bucket: intelpush-chart-library.

https://intelpush-image-worker.jmm70.workers.dev/library/chart_6.png

Client API — Demo

https://intelpush-pwa.vercel.app/api

Demo endpoints that simulate a client (neobank backend) triggering a notification after a payment event. Each call orchestrates the full pipeline: selects the active insight config, calls the AI Worker for the body text, calls the Image Worker for the chart, sends via Firebase FCM to all registered devices, and saves the result to notifications_history.

POST /api/notify Send smart notification (Android + PWA)

Body JSON

Field	Type		Description
creditCardNumber	string	required	Cardholder identifier
merchantCode	string	required	Merchant code from `/api/merchants`
amount	number	required	Transaction amount
category	string	optional	Transaction category (used for insight condition matching)

Response 200

{
  "success": true,
  "title": "Hi Lauren, you spent $10.00 at McDonald's / Lake Shore Dr",
  "body": "Food spending up 12% this month vs last month.",
  "sent": 2,
  "insight_source": "campaign",
  "insight_code": 1,
  "prompt_code": 3,
  "chart_code": 6
}

Sends two separate Firebase multicasts: one for web tokens (PWA button labels) and one for Android tokens (native button + inline reply labels). Both platforms receive the chart URL when the active insight has chart: true.

POST /api/notify-v2 Send smart notification — web-optimised body

Body JSON

Field	Type		Description
creditCardNumber	string	required	Cardholder identifier
merchantCode	string	required	Merchant code from `/api/merchants`
amount	number	required	Transaction amount
category	string	optional	Transaction category (used for insight condition matching)

Response 200

{
  "success": true,
  "title": "Hi Lauren, you spent $10.00 at McDonald's / Lake Shore Dr",
  "body": "Food up 12% vs last month.",
  "sent": 2,
  "insight_source": "campaign",
  "insight_code": 1,
  "prompt_code": 3,
  "chart_code": 6
}

Identical to /api/notify with one difference: when the insight includes a chart, the AI Worker is called with max_chars=100 so Mistral generates a telegraphic phrase that fits alongside the chart image in the notification without being cut off.

PWA (Vercel)

https://intelpush-pwa.vercel.app/api

Next.js app deployed on Vercel. Manages push tokens, sends notifications via Firebase, and exposes merchant and cardholder data for the user interface.

GET /api/register-token Check if a cardholder has a registered push token

Query params

Param	Type		Description
ccNum	string	required	Credit card number
platform	string	optional	Filter by platform ("web", "android"…)

{ "registered": true }

POST /api/register-token Register or update an FCM token

Body JSON

Field	Type
creditCardNumber	string	required
fcmToken	string	required
platform	string	optional

{ "success": true }

POST /api/send-notification Send push notification via Firebase

Body JSON

Field	Type		Description
creditCardNumber	string	required	Cardholder identifier
merchantCode	string	required	Merchant code
amount	number	required	Transaction amount
category	string	required	Transaction category

Orchestrates: calls the AI Worker for the insight, the Image Worker for the chart, and sends via Firebase. Saves the result to notifications_history.

GET /api/merchants List merchants (with optional category filter)

Query params

Param	Type		Description
category	string	optional	Category code
ccNum	string	optional	If provided, prioritises personalised merchants

[{ "code": "...", "name": "Shell", "categoryCode": "gas_transport", "city": "...", "state": "..." }]

GET /api/merchant-categories List merchant categories

[{ "code": "food_dining", "name": "Food & Dining" }]

POST /api/notification-feedback Save feedback for a notification

Body JSON

Field	Type
notificationId	string	required
type	string	required
value	string	optional

{ "success": true }

GET /api/users List all cardholders

[{ "_id": "...", "firstName": "Lauren", "lastName": "Anderson", "creditCardNumber": "...", "city": "...", "state": "..." }]

No pagination. For search and pagination use GET /cardholders from the Management API.

Management API

Categories

Insights

AI Worker

Image Worker

Client API — Demo

PWA (Vercel)