Skip to content

Documentation

Find the path from first app to observable delivery.

Start with the concepts that shape a safe integration, then move into app setup, devices, campaigns, triggers, and delivery diagnostics.

Documentation mapReference online
Overview
Audience
Messages
Delivery
Settings

Live workspace

Recommended path

Core guides

06

API format

OpenAPI

Base path

/api/v1
Current flow
1. App setupProvider and readiness
2. DevicesIdentity and tokens
3. MessagingCampaigns and events

Example data for product illustration. Not customer performance.

Documentation should explain the model, not only list endpoints.

PushHub connects each request to ownership, lifecycle, failure behavior, and the next operational step so teams can build without guessing at hidden state.

How it works

Read in the order the platform becomes useful.

01

Learn the model

Understand companies, apps, users, roles, devices, campaigns, and delivery states.

02

Prepare an app

Configure provider credentials and verify readiness without sending to a real player.

03

Integrate devices

Register and maintain token, platform, player, and property context.

04

Add messaging

Use campaigns, segments, templates, triggers, analytics, and troubleshooting guidance.

Capability depth without the fine-print surprise.

Current and planned capabilities are labeled directly, so teams can evaluate PushHub without confusing vision for availability.

Live

Hosted documentation

Browse deployment, workspace, admin, trial, delivery, and SDK guidance on the docs host.

Live

REST API reference

Use the validated OpenAPI contract for endpoint, payload, and response discovery.

Beta

JavaScript SDK guide

Follow the typed client path while the SDK surface continues to mature.

Roadmap

Interactive API explorer

A planned authenticated explorer will generate safe sample requests from the published contract.

In the game

Documentation for each operating role.

01

Backend engineer

Integrate keys, devices, events, idempotency, and error behavior.

Build
02

LiveOps operator

Understand campaigns, audiences, templates, experiments, and status.

Operate
03

Platform owner

Review security, deployment, recovery, admin controls, and limits.

Govern

The docs follow the deployed platform.

Architecture decisions, workflow changes, APIs, operational scripts, and release behavior are updated alongside implementation to prevent silent drift.

Versioned decisions

Architecture records explain major operational choices.

Validated contract

OpenAPI lint remains part of the release gate.

No secret examples

Documentation uses placeholders and never publishes production credentials.

Questions teams ask before they commit.

The docs site links directly to the hosted REST API reference and SDK guidance.

Give your backend a calmer push boundary.

Start with one app, one meaningful moment, and one audience worth reaching.