pubnub/skills
Builds real-time analytics and automation with PubNub Illuminate.
npx skills add pubnub/skills --skill pubnub-illuminate
Related neighbors and high-traction skills in the same topics — useful to compare before installing.
Browser automation CLI for AI agents. Use when the user needs to interact with websites, includ…
810.4K installsReview UI code for Web Interface Guidelines compliance. Use when asked to "review my UI", "chec…
617.3K installsBuild, deploy, evaluate, optimize, fine-tune, and manage Microsoft Foundry agents, models, and …
576.5K installsArchitect and provision enterprise Azure infrastructure from workload descriptions. For cloud a…
402.8K installsOther skills from pubnub/skills · top by installs.
npx skills add pubnub/skills
Declared targets from SKILL.md / docs. Unmarked agents are not listed — the skill may still install via the CLI.
master
Parsed from SKILL.md frontmatter.
Files included with this skill beyond the listing page.
SKILL.md
11,103 B
SUMMARY.md
433 B
You are the Illuminate specialist. Your role is to help developers create real-time analytics and automation using PubNub's Business Objects, Metrics, Decisions, Queries, and Dashboards — without writing backend code.
Invoke this skill when:
manage_illuminate MCP toolResources are built in dependency order. Skipping or reordering breaks things:
All Illuminate calls go to the PubNub Admin API. Every request requires both headers:
POST /v2/illuminate/business-objects HTTP/1.1
Host: admin-api.pubnub.com
Authorization: <ILLUMINATE_API_KEY>
PubNub-Version: 2026-02-09
Content-Type: application/jsonGet the API key from Service Integrations (see [references/service-integration-auth.md](references/service-integration-auth.md)). Store it in ILLUMINATEAPIKEY env var or your secrets manager — see [pubnub-keyset-management/references/key-rotation-and-hygiene.md](../pubnub-keyset-management/references/key-rotation-and-hygiene.md) for storage rules.
Illuminate evaluates JSONPath against a normalized document. The Illuminate Admin UI (Business Object field source) exposes a fixed Category → Subcategory map; that is the exhaustive top-level split the product gives you. Deeper keys (e.g. under body or custom) are your normal JSONPath continuation.
message — PubNub message slice
| Subcategory | JSONPath prefix | Notes |
|---|---|---|
| body | $.message.body |
Your published payload; append . / [] for nested app fields (e.g. $.message.body.user_id). |
| meta | $.message.meta |
Message metadata object; extend with nested keys as needed. |
| userId | $.message.userId |
Publisher UUID (scalar path). |
| channel | $.message.channel |
Channel name on the message (scalar path). |
channel — Channel object (App Context–style channel record on the document)
| Subcategory | JSONPath prefix |
|---|---|
| name | $.channel.name |
| type | $.channel.type |
| status | $.channel.status |
| custom | $.channel.custom |
user — User object
| Subcategory | JSONPath prefix |
|---|---|
| externalId | $.user.externalId |
| type | $.user.type |
| status | $.user.status |
| custom | $.user.custom |
membership — Membership object
| Subcategory | JSONPath prefix |
|---|---|
| status | $.membership.status |
| custom | $.membership.custom |
After the subcategory: add the remaining path for nested or custom properties (e.g. $.message.body.data.score, $.channel.custom.lastSentMessageUnixTime, $.membership.custom.lastReadUnixTime). If a path does not match the live shape, use a raw row snapshot (queries/execute with no transforms) to confirm.
| Resource | Depends on | Owns |
|---|---|---|
| Business Object | nothing | schema (fields extracted from messages) |
| Metric | a Business Object | aggregation over a time window |
| Query | a Business Object | flexible pipeline (alternative to Metric) |
| Decision | a Metric, BO, or Query | conditions + actions |
| Dashboard | Metrics (and optionally Decisions for overlays) | visualization |
Cascade delete behavior: deleting a parent cascades to dependent analytics resources. Deleting a Business Object permanently deletes all dependent Metrics, Decisions, and Queries. Dashboards themselves remain (they are usually account-level containers), but charts tied to metrics backed by that Business Object are removed. Confirm before destructive operations.
These will save days of debugging. They are documented in detail in [references/decisions-4-step-workflow.md](references/decisions-4-step-workflow.md):
activeFrom and activeUntil are required on every Decision POST (the API documents them as optional but returns a 500 if you omit them).hitType: "SINGLE" and executeOnce: false are also required.inputFields must be manually constructed in the POST body — they are not auto-populated from the Metric or Query.rules: [] and enabled: false, READ auto-generated IDs, PUT with rules, PUT to enable.executionLimitType: "ONCEPERINTERVALPERCONDITION" is not valid despite appearing in some docs. Use ONCEPERINTERVALPERCONDITION_GROUP.sourceId and businessObjectId set to the same BO ID.executionFrequency entirely (don't send null).$.message.body.TEXT_LONG fields per BO60, 300, 600, 900, 1800, 3600, 86400 secondsisActive: true — set inactive firstinputFields, outputFields, actions) while enabled — set enabled: false firstDELETEWhen this skill is active, prefer:
manage_illuminate — create, read, update, delete all five resource types (Business Objects, Metrics, Decisions, Queries, Dashboards). Handles the auth header injection.For runtime testing of message data flowing into Business Objects, use:
sendpubnubmessage — publish test datasubscribeandreceivepubnubmessages — confirm test publishes are flowingAPPCONTEXTSETUSERMETADATA, APPCONTEXTSETCHANNELMETADATA, APPCONTEXTSETMEMBERSHIP_METADATAPUBNUB_PUBLISH actions [publish messages](../pubnub-app-developer/references/publish-subscribe.md) to a channelWhen providing implementations:
activeFrom, activeUntil, hitType, executeOnce) even when the user didn't ask.