Forms

Explicitly write a form definition or final submission batch to GitHub through the optional writeback app.

Requires commentary.forms.writeback, the forms.github_writeback license feature, a configured optional GitHub writeback app, an installed repository target, and a valid branch/path target. Submission writeback accepts submissionId or submissionIds, writes one canonical JSON result file per submission in one commit, overwrites existing result paths, can explicitly create target branches with target.createBranch and target.baseBranch, and can optionally open a pull request. Commentary storage remains available when writeback is unavailable.

post/api/v1/forms/{formId}/destinations/writeback

Request

  • Base URL: https://commentary.dev
  • URL: https://commentary.dev/api/v1/forms/{formId}/destinations/writeback
  • Auth: HTTP bearer

Path parameters

formIdstring required

Form id or reference id.

Headers

X-Commentary-Workspace-Idstring

Must match the credential workspace. This header cannot widen grant authority.

X-Correlation-Idstring

Request body

targetType'form_definition' | 'submission'
submissionIdstring
submissionIdsstring[]
format'json' | 'yaml'
commitMessagestring
openPullRequestboolean
pullRequestTitlestring
pullRequestBodystring

Response

Successful response.

okunknown
formIdstring
submissionIdstring
submissionIdsstring[]
writebackobject

Changes

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