PubNub API Documentation

This is the complete API documentation for connecting to the PubNub API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.

MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.

Meet PubNub: PubNub is a real-time messaging and event-streaming platform for building chat, live collaboration, alerts, and multi-tenant communication systems. Keep reading to get started.

Quickstart

Before you run your first PubNub request, you need three things:

1. A MindCloud account — sign in or create an account at MindCloud.
2. A MindCloud API Key — create one in API Keys. Keep it on your server.
3. At least one PubNub connection — create or choose one in Connections. Note its connectionId.

Every PubNub action uses the same URL pattern:

https://connect.mindcloud.co/v1/universal/pubNub/latest/actions/{actionSlug}

You need a MindCloud API Key and a PubNub connection. Then call an action such as Get App:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/pubNub/latest/actions/get-app" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

Every response comes back in the same envelope, with your rows in a data array:

{
  "success": true,
  "data": [
    { "id": "1042", "name": "Ava" }
  ],
  "meta": {}
}

After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.

Authentication

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected PubNub account that should run the action. MindCloud stores and refreshes the PubNub credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.

PubNub actions

All 34 published actions for this PubNub version. Each page documents the endpoint, arguments, and response controls.

• PUTAssign Keysets To Customer
• POSTCreate App
• POSTCreate Business Object
• POSTCreate Customer
• POSTCreate Keyset
• DELETEDelete App
• DELETEDelete Keyset
• DELETEDelete Rotated Secret Key
• GETGet App
• GETGet Customer
• GETGet Customer By Keyset
• GETGet Insights Data
• GETGet Keyset
• GETGet Keyset Configuration
• GETGet Top N Insights Data
• GETGet Usage Metrics
• POSTIssue Customer Access Token
• GETList Applications For Customer
• GETList Apps
• GETList Business Objects
• GETList Customers
• GETList Dashboards
• GETList Decisions
• GETList Keysets
• GETList Keysets For Customer
• GETList Metrics
• GETList Queries
• GETList Secret Keys For Keyset
• PUTRotate Secret Key
• PUTUpdate App
• PUTUpdate Customer
• PUTUpdate Keyset
• PUTUpdate Keyset Configuration
• PUTUpdate Secret Key Expiration Time

Related apps

More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.

GmailSlackDiscordTwilioMicrosoft TeamsCircletl;dvClickSend SMS