# 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.

Canonical: https://commentary.dev/docs/reference/api/stream-form-submission-events

`GET /api/v1/forms/{formId}/submissions/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.

## Access

Use a credential with `commentary.forms.read`.

Provider access, workspace membership, and agent grants are enforced separately. A token does not expand access to a repository or resource. [Set up developer access](/docs/build/developer-access).

## Parameters

| Name | Location | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `formId` | path | string | Yes | Form id or reference id. |
| `cursor` | query | string | No | Event cursor or latest. |
| `once` | query | `"1"` | No | Return the current batch and close. |
| `kind` | query | string | No | Source context kind for review-scoped submissions. |
| `draftReviewSessionId` | query | string | No |  |
| `webAppReviewId` | query | string | No |  |
| `owner` | query | string | No |  |
| `repo` | query | string | No |  |
| `prNumber` | query | integer | No |  |
| `branchRef` | query | string | No |  |
| `filePath` | query | string | No |  |
| `documentVersionId` | query | string | No |  |
| `formInstanceId` | query | string | No |  |
| `X-Commentary-Workspace-Id` | header | string | No | Must match the credential workspace. This header cannot widen grant authority. |
| `X-Correlation-Id` | header | string | No |  |

## Call the endpoint

Replace path placeholders and your credential. For body operations, create `request.json` using the required fields above; this command does not invent resource identifiers or consent.

```bash
curl --request GET \
  'https://commentary.dev/api/v1/forms/<formId>/submissions/events' \
  --header 'Authorization: Bearer <your-token>'
```

## Responses

| Status | Meaning | Payload |
| --- | --- | --- |
| `200` | Server-Sent Events stream. | See response headers or body contract |
| `400` | The request was invalid. | [ExternalError](/docs/reference/schemas/external-error) |
| `401` | Authentication is required. | [ExternalError](/docs/reference/schemas/external-error) |
| `403` | The token or session does not have permission for this resource. | [ExternalError](/docs/reference/schemas/external-error) |
| `404` | The resource was not found. | [ExternalError](/docs/reference/schemas/external-error) |
| `429` | The request was rate limited. | [ExternalError](/docs/reference/schemas/external-error) |

## Recover from errors

Use the returned status and error body. Correct invalid fields before retrying; reconnect or narrow the target for authentication and permission errors. For conditional writes, reload the latest version before preparing a new request. Respect rate-limit headers and retry only when the operation’s idempotency contract permits it.

## Contract and related guidance

Operation ID: `streamFormSubmissionEvents`. [Download the OpenAPI contract](/docs/reference/openapi.json) for complete constraints and code generation. [Browse endpoints](/docs/reference/api-operations).