Forms

Stream final form submission events using Server-Sent Events.

Streams summary-only submission.submitted events for permitted result contexts. Raw values are not included in the event payload; call the submission detail endpoint when value access is required.

get/api/v1/forms/{formId}/submissions/events

Request

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

Path parameters

formIdstring required

Form id or reference id.

Query parameters

cursorstring

Event cursor or latest.

once'1'

Return the current batch and close.

kindstring

Source context kind for review-scoped submissions.

draftReviewSessionIdstring
webAppReviewIdstring
ownerstring
repostring
prNumberinteger
branchRefstring
filePathstring
documentVersionIdstring
formInstanceIdstring

Headers

X-Commentary-Workspace-Idstring

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

X-Correlation-Idstring

Response

Server-Sent Events stream.

Changes

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