Appzi API Documentation

This is the complete API documentation for connecting to the Appzi 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 Appzi: Collect website feedback and user surveys with Appzi portal-based widgets, targeting, and triggers. Keep reading to get started.

Quickstart

Before you run your first Appzi 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 Appzi connection — create or choose one in Connections. Note its connectionId.

Every Appzi action uses the same URL pattern:

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

You need a MindCloud API Key and a Appzi connection. Then call an action such as Capture Canvas WebGL Content:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/appzi/latest/actions/capture-canvas-web-gl-content" \
  --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 Appzi account that should run the action. MindCloud stores and refreshes the Appzi 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.

Appzi actions

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

• PUTAdd Custom Feedback Data
• PUTAdd Debug Metadata
• PUTAdd Feedback Metadata
• GETCapture Canvas WebGL Content
• GETCapture Specific Elements In Screenshots
• GETConfigure Appzi CSP Headers
• GETConfigure Auto-Triggers
• GETEnable Client-Side Screenshot Renderer
• GETEnable Screenshot Debug Mode
• GETEnable Server-Side Trigger Tracking
• GETEnable WCAG Mode
• GETExclude Elements From Screenshots
• GETFilter Events By Survey ID
• POSTGenerate Client Bundle Install Instructions
• POSTGenerate Client Framework Install Instructions
• POSTGenerate Dynamic Feedback Data
• POSTGenerate JavaScript Loader
• POSTGenerate One-Line Install Script
• POSTGenerate Settings Object
• POSTGenerate SSR Install Instructions
• GETGet Event Object Structure
• GETInclude Appzi Script Under CSP
• GETList Portal Survey Configurations
• GETListen For Survey Events
• POSTOpen Survey From Ready Callback
• POSTOpen Survey Inline
• POSTOpen Survey On Page Load
• POSTOpen Survey Via HTML Attribute
• GETPrepare CSP-Compatible Appzi Install
• PUTSet Lifecycle Targeting Metadata
• PUTSet User Identification
• PUTTrack User Context Data
• POSTTrigger Function On Survey Open
• GETUse Client-Side Screenshot Renderer
• GETUse Custom JavaScript Targeting
• GETUse Default Screenshot Renderer
• GETUse Default Targeting Rules
• GETUse Standard Accessibility Mode
• GETVerify Installation

Related apps

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

Google CalendarNotionTypeformJira Software CloudSmartsheetCal.comWufooBasecamp