> For the complete documentation index, see [llms.txt](https://docs.truedat.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.truedat.io/v8.12/api-integrations/data-quality-apis/quality-events.md).

# Quality Events

## Create quality event

> Records a quality event for a specific execution. Quality events are the primary mechanism used by external runners to report progress and outcome back to the system.\
> \
> Requires administrative privileges (\*\*administrator or service account\*\*).\
> \
> \*\*Request body:\*\*\
> \- \`quality\_event\` (required) – Object containing:\
>   \- \`type\` (required, string) – Event type, for example 'PENDING', 'SUCCESS', 'ERROR'.\
>   \- \`message\` (optional, string) – Optional free‑text message attached to the event.\
> \
> The event is created and linked to the execution. The \`execution\_id\` from the path is injected into the payload automatically; any value supplied in the body is ignored.<br>

```json
{"openapi":"3.0.0","info":{"title":"td-dq","version":"Truedat 8.11.0"},"paths":{"/api/executions/{execution_id}/quality_events":{"post":{"description":"Records a quality event for a specific execution. Quality events are the primary mechanism used by external runners to report progress and outcome back to the system.\n\nRequires administrative privileges (**administrator or service account**).\n\n**Request body:**\n- `quality_event` (required) – Object containing:\n  - `type` (required, string) – Event type, for example 'PENDING', 'SUCCESS', 'ERROR'.\n  - `message` (optional, string) – Optional free‑text message attached to the event.\n\nThe event is created and linked to the execution. The `execution_id` from the path is injected into the payload automatically; any value supplied in the body is ignored.\n","operationId":"TdDqWeb.QualityEventController.create","parameters":[{"description":"Execution ID","in":"path","name":"execution_id","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualityEventCreateRequest"}}},"description":"Quality event creation request","required":false},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/QualityEventCreateResponse"}}},"description":"Quality event response"},"401":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDqUnauthorizedResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDqForbiddenResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDqNotFoundResponse"}}},"description":"Not found"},"422":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDqUnprocessableEntityResponse"}}},"description":"Unprocessable Entity"},"500":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TdDqInternalServerErrorResponse"}}},"description":"Internal Server Error"}},"summary":"Create quality event","tags":["Quality Events"]}}},"components":{"schemas":{"QualityEventCreateRequest":{"additionalProperties":false,"properties":{"quality_event":{"additionalProperties":false,"properties":{"message":{"description":"Optional message","nullable":true,"type":"string"},"type":{"description":"Event type (e.g., SUCCESS, ERROR)","type":"string"}},"required":["type"],"type":"object"}},"required":["quality_event"],"title":"QualityEventCreateRequest","type":"object"},"QualityEventCreateResponse":{"additionalProperties":false,"properties":{"data":{"$ref":"#/components/schemas/QualityEvent"}},"required":["data"],"title":"QualityEventCreateResponse","type":"object"},"QualityEvent":{"additionalProperties":false,"properties":{"execution_id":{"type":"integer"},"id":{"type":"integer"},"inserted_at":{"format":"date-time","type":"string"},"message":{"nullable":true,"type":"string"},"type":{"type":"string"}},"required":["id","inserted_at","execution_id","type"],"title":"QualityEvent","type":"object"},"TdDqUnauthorizedResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdDqUnauthorizedResponse","type":"object"},"TdDqForbiddenResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdDqForbiddenResponse","type":"object"},"TdDqNotFoundResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdDqNotFoundResponse","type":"object"},"TdDqUnprocessableEntityResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdDqUnprocessableEntityResponse","type":"object"},"TdDqInternalServerErrorResponse":{"properties":{"errors":{"properties":{"detail":{"type":"string"}},"type":"object"}},"title":"TdDqInternalServerErrorResponse","type":"object"}}}}
```