Apps

Render OSP Plugin

Changed on

Invoke an Order Status Page Plugin and return rendered HTML. Authenticated via tracking security hash — no API token required. Pass tracking_id (MongoDB ObjectId) and s (security hash) as query parameters.

post/v4/apps/deployments/{uuid}/render/

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

uuidstring uuid required

Query parameters

sstring required

Security hash of the tracking document

tracking_idstring required

24-char hex MongoDB ObjectId of the tracking document (CheckpointHeader.id)

Response

htmlstring required
inlineScriptstring nullable

Changes