Integrations

Preview or publish completed Study feedback as native Figma comments

post/api/v1/integrations/figma/comments

Request

  • Base URL: https://api.getminds.ai
  • URL: https://api.getminds.ai/api/v1/integrations/figma/comments
  • Auth: HTTP bearer

Request body

studyIdstring uuid required
runIdstring uuid required
frameUrlstring required

Figma design frame link with node-id.

expectedNodeIdstring
action'preview' | 'publish'
feedback'summary' | 'heatmap'
messageIdstring

Completed image heatmap message, required for heatmap feedback.

assetKeystring

Image asset key; use an empty string for the primary image heatmap.

sceneIdstring
previewHashstring

Current preview hash, required for publishing.

commentKeysstring[]

Explicitly reviewed comment keys, required for publishing.

Response

Preview or delivery receipts. Partial delivery must be inspected before retrying.

Changes

No recorded changes to this operation across all 1 revision of this API.