Models
Reusable component schemas are documented once and linked from every operation that uses them.
| Model | Description |
|---|---|
| HealthResponse | Literal process-liveness response returned by the JavaScript template. |
| TextError | Human-readable template error text. App Connect does not parse it as a stable machine error code. |
| PluginRegistrationRequest | Account registration input sent by the App Connect server to the configured plugin registration URL. |
| PluginRegistrationResponse | Plugin-issued account credential that App Connect stores for later server-to-server calls. |
| EmptyObject | Empty JSON object used as the token synchronization request body. |
| LoggingPayload | Opaque workflow- and connector-dependent call, SMS, or fax logging payload. It can contain contact details, communication contents, CRM metadata, and recording download URLs with embedded access tokens. Treat it as sensitive and untrusted. A synchronous plugin must preserve every field required by subsequent plugins and connector logging. |
| PluginConfig | User-scoped manifest configuration read from the installed plugin setting. Entries commonly contain nested value and customization metadata. The object can be null or omit values on older or admin-managed clients; validate it and apply server-side defaults. |
| PluginInvocationRequest | Envelope sent to a synchronous plugin; the successful response must be the bare LoggingPayload. |
| AsyncCallbackInvocationRequest | Asynchronous call create or update invocation with a one-week callback task and bearer-capability callback URL. |
| AsyncFireAndForgetInvocationRequest | Current asynchronous SMS or fax invocation. It has no task identifier or callback URL, and App Connect does not await its response. |
| AsyncAcceptanceResponse | JavaScript-template acknowledgment. App Connect does not inspect this body. |
| AsyncRejectedResponse | JavaScript-template rejection when required callback fields are absent. |
| AsyncPluginCallbackRequest | Plugin completion report for a callback-enabled asynchronous call task. |
| AsyncPluginCallbackResponse | App Connect callback-processing result. successful describes whether the callback was accepted or processed, not whether the plugin background work succeeded. |
| PluginLicenseStatus | Advisory account entitlement result forwarded to the browser UI; it does not currently gate plugin execution. |
| PluginAuthUrlResponse | Preferred JSON response containing the third-party provider authorization URL. |
| PluginAuthStateResponse | Browser-facing result reused for plugin authorization-state checks and logout. |
| PluginLogoutRequest | Current browser logout payload containing an optional opaque App Connect CRM-session token. |
| ReturnMessage | Optional user-facing notification returned by connector and App Connect workflows. |