# Appzi API Documentation

This is the complete API documentation for connecting to the Appzi API using MindCloud's Universal API.

MindCloud offers one normalized API to access 3,400+ apps from a single place. It centralizes authentication and normalizes app APIs so they are easier and more consistent to use.

## Quickstart

1. A **MindCloud account** — sign in or create an account at [MindCloud](https://app.mindcloud.co).
2. A **MindCloud API Key** — create one in [API Keys](https://app.mindcloud.co/user/api-keys). Keep it on your server.
3. At least one **Appzi connection** — create or choose one in [Connections](https://app.mindcloud.co/credentials). Note its `connectionId`.

```text
POST https://connect.mindcloud.co/v2/universal/apps/appzi/actions/{actionSlug}/run
```

## Appzi actions

- PUT `add-custom-feedback-data` Add Custom Feedback Data
- PUT `add-debug-metadata` Add Debug Metadata
- PUT `add-feedback-metadata` Add Feedback Metadata
- GET `capture-canvas-web-gl-content` Capture Canvas WebGL Content
- GET `capture-specific-elements-in-screenshots` Capture Specific Elements In Screenshots
- GET `configure-appzi-csp-headers` Configure Appzi CSP Headers
- GET `configure-auto-triggers` Configure Auto-Triggers
- GET `enable-client-side-screenshot-renderer` Enable Client-Side Screenshot Renderer
- GET `enable-screenshot-debug-mode` Enable Screenshot Debug Mode
- GET `enable-server-side-trigger-tracking` Enable Server-Side Trigger Tracking
- GET `enable-wcag-mode` Enable WCAG Mode
- GET `exclude-elements-from-screenshots` Exclude Elements From Screenshots
- GET `filter-events-by-survey-id` Filter Events By Survey ID
- POST `generate-client-bundle-install-instructions` Generate Client Bundle Install Instructions
- POST `generate-client-framework-install-instructions` Generate Client Framework Install Instructions
- POST `generate-dynamic-feedback-data` Generate Dynamic Feedback Data
- POST `generate-java-script-loader` Generate JavaScript Loader
- POST `generate-one-line-install-script` Generate One-Line Install Script
- POST `generate-settings-object` Generate Settings Object
- POST `generate-ssr-install-instructions` Generate SSR Install Instructions
- GET `get-event-object-structure` Get Event Object Structure
- GET `include-appzi-script-under-csp` Include Appzi Script Under CSP
- GET `list-portal-survey-configurations` List Portal Survey Configurations
- GET `listen-for-survey-events` Listen For Survey Events
- POST `open-survey-from-ready-callback` Open Survey From Ready Callback
- POST `open-survey-inline` Open Survey Inline
- POST `open-survey-on-page-load` Open Survey On Page Load
- POST `open-survey-via-html-attribute` Open Survey Via HTML Attribute
- GET `prepare-csp-compatible-appzi-install` Prepare CSP-Compatible Appzi Install
- PUT `set-lifecycle-targeting-metadata` Set Lifecycle Targeting Metadata
- PUT `set-user-identification` Set User Identification
- PUT `track-user-context-data` Track User Context Data
- POST `trigger-function-on-survey-open` Trigger Function On Survey Open
- GET `use-client-side-screenshot-renderer` Use Client-Side Screenshot Renderer
- GET `use-custom-java-script-targeting` Use Custom JavaScript Targeting
- GET `use-default-screenshot-renderer` Use Default Screenshot Renderer
- GET `use-default-targeting-rules` Use Default Targeting Rules
- GET `use-standard-accessibility-mode` Use Standard Accessibility Mode
- GET `verify-installation` Verify Installation