Sign in
mini-apps

Publish a mini-app preview entry

Publishes a mini-app preview entry. Called by the mini-apps preview deploy pipeline to register a throwaway preview deploy, keyed by its unique preview id. Re-publishing an existing preview id refreshes every deploy-managed field. Preview entries are independent from the main catalog: they carry no slug, owner, or membership gating, and anyone with the preview link can access the app.

post/mini-apps/publish-preview

Request body

iconstring nullable

Square mini-app icon URL.

coverstring nullable

Cover image or video URL used when no card artwork is available. Video URL paths must end in .mp4 or .webm.

cardstring nullable

Preferred app catalog image or video thumbnail URL. Video URL paths must end in .mp4 or .webm.

Response

Mini-app preview published successfully

preview_idstring required

Unique, URL-safe preview identifier composed by the deploy pipeline.

Example response

{
  "preview_id": "preview_id"
}

Changes

Changed in 4 of the 34 revisions of this API.214

  • cb077a6ff5801See the full diff
    • ▲

      removed the enum value mfe of the request property

      request-property-enum-value-removed

  • 4918f84cbfd71See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • bd40f367a834112See the full diff
    • ▲

      added the pattern ^[a-z0-9]+(?:-[a-z0-9]+)*$ to the request property

      request-property-pattern-added

    • ●

      the request property's maxLength was set to 64

      request-property-max-length-set

    • ○

      the endpoint scheme security ApiKeyAuth was added to the API

      api-security-added

    • ○

      the response's property pattern ^[a-z0-9]+(?:-[a-z0-9]+)*$ was added for the status

      response-property-pattern-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3cece82bbf1d1See the full diff
    • ○

      endpoint added

      endpoint-added