Schema for webhook event payloads that Coalesce Quality POSTs to your endpoint on issue and incident lifecycle events.
Not to be used directly. Use the IssuesService instead when calling via API.
Actor marking the issue as expected.
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectMust be at least 1 characters long
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectMust be at least 1 characters long
Additional Properties of any type are allowed.
Type: object^VIA_UNSPECIFIED$
Value must be greater or equal to -2147483648 and lesser or equal to 2147483647
Additional Properties of any type are allowed.
Type: objectID of the issue to mark as expected.
Must match regular expression:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Must be at least 1 characters long
Ignore status change if the issue already has a status.
Time at which the issue was marked as expected. Defaults to the current time.
Additional Properties of any type are allowed.
Type: objectActor marking the issue as fixed.
Same definition as actorID of the issue to mark as fixed.
Must match regular expression:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Must be at least 1 characters long
Ignore status change if the issue already has a status.
Time at which the issue was marked as fixed. Defaults to the current time.
Same definition as timeAdditional Properties of any type are allowed.
Type: objectActor marking the issue as investigating.
Same definition as actorID of the issue to mark as investigating.
Must match regular expression:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Must be at least 1 characters long
Ignore status change if the issue already has a status.
Time at which the issue was marked as investigating. Defaults to the current time.
Same definition as timeAdditional Properties of any type are allowed.
Type: objectActor marking the issue as no action needed.
Same definition as actorID of the issue to mark as no action needed.
Must match regular expression:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Must be at least 1 characters long
Ignore status change if the issue already has a status.
Time at which the issue was marked as no action needed. Defaults to the current time.
Same definition as timeAdditional Properties of any type are allowed.
Type: objectActor posting the comment.
Same definition as actorComment to post.
ID of the issue to post a comment on.
Must match regular expression:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Must be at least 1 characters long
Time at which the comment was posted. Defaults to the current time.
Same definition as timeAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: object^EVENT_TYPE_UNSPECIFIED$
Value must be greater or equal to -2147483648 and lesser or equal to 2147483647
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectDetailed description of the issue. In the Markdown format.
Detailed description of the issue. In the HTML format.
Entities directly affected by the issue, not considering downstream ones.
No Additional ItemsIdentifier is a unique reference to an entity in Coalesce Quality system. Entity identifiers
are designed to closely mimic identifiers used by data platforms and tools. To construct
an identifier, you need to know the kind of the entity and the ids that you would normally
use to identify it in the data platform or tool. For example, to identify a table in BigQuery,
you would need to know the project, dataset, and table names.
Airflow DAG identifier
Airflow dag_id that identifies the DAG
Coalesce Quality integration_id that identifies the Airflow instance
Additional Properties of any type are allowed.
Type: objectAirflow task identifier within a given DAG
Airflow dag_id that identifies the DAG
Coalesce Quality integration_id that identifies the Airflow instance
Airflow task_id that identifies the task within the DAG
Additional Properties of any type are allowed.
Type: objectAmazon Athena (Glue) table identifier
Glue Data Catalog name. Almost always "AwsDataCatalog" — the default
catalog for Athena unless the customer registered a federated catalog.
Glue database (the namespace users typically filter on).
AWS account and region the Athena workgroup runs in, formatted as
"<account-id>.<region>" (e.g. "123456789012.eu-west-1"). Auto-derived
from sts:GetCallerIdentity at integration setup time.
Glue table or view name.
Additional Properties of any type are allowed.
Type: objectBigQuery table identifier
BigQuery dataset id
BigQuery project
BigQuery table name
Additional Properties of any type are allowed.
Type: objectClickhouse table identifier
Clickhouse hostname without port
Clickhouse database
Clickhouse table
Additional Properties of any type are allowed.
Type: objectCustom identifier to be used with all custom created entities
Id that identifies the custom entity
The Id should be unique within the custom entity Identifier.
Additional Properties of any type are allowed.
Type: objectDatabricks table identifier
Databricks catalog
Databricks schema
Databricks table or view
URL of Databricks workspace
Additional Properties of any type are allowed.
Type: objectDataproduct identifier
Dataproduct id that identifies the Dataproduct
Must match regular expression:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectDbt node that identifies one of dbt DAG nodes (model, test, etc) in dbt Cloud project
Your dbt Cloud account id
Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)
Your dbt Cloud project id
Additional Properties of any type are allowed.
Type: objectDbt node that identifies one of dbt DAG nodes (model, test, etc) in dbt Core project
Opaque identifier of the dbt Core project. Usually the Coalesce Quality
integration id (a UUID), but may also be the dbt project name from
manifest.json when the integration is configured to identify assets by
project name. Treat it as an opaque string, not a UUID.
Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)
Additional Properties of any type are allowed.
Type: objectMicrosoft Fabric table identifier
Fabric warehouse / lakehouse (database).
Workspace SQL analytics endpoint host, e.g.
"<workspace-id>.datawarehouse.fabric.microsoft.com".
Schema within the database.
Table or view name.
Entra (Azure AD) tenant GUID, decoded from the endpoint host in instance.
Optional and informational, like workspace_id.
Fabric workspace GUID, decoded from the endpoint host in instance.
Optional and informational: the table is addressed by
instance/database/schema/table, so leave it empty if you don't have it —
it does not affect how the identifier resolves.
Additional Properties of any type are allowed.
Type: objectMonitor identifier
Coalesce Quality integration_id of the monitored identifier
Identifier of the monitor
Optional monitor segmentation identifier
Additional Properties of any type are allowed.
Type: objectSQL Server table identifier
SQL Server database
Hostname of the SQL Server instance
SQL Server schema (e.g. "dbo")
SQL Server table or view
Additional Properties of any type are allowed.
Type: objectMysql table identifier
Mysql hostname without port
Mysql database
Mysql table
Additional Properties of any type are allowed.
Type: objectOracle table identifier
Hostname of the Oracle instance
Oracle schema (= owning user)
Oracle service name (PDB)
Oracle table or view
Additional Properties of any type are allowed.
Type: objectPostgres table identifier
Postgres database
Postgres hostname without port
Postgres schema
Postgres table
Additional Properties of any type are allowed.
Type: objectRedshift table identifier
Redshift cluster
Redshift database
Redshift schema
Redshift table
Additional Properties of any type are allowed.
Type: objectSaved view identifier
Saved view id (client-supplied UUID) that identifies the saved view
Must match regular expression:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectSnowflake table identifier
Snowflake account
Snowflake database
Snowflake schema
Snowflake table
Additional Properties of any type are allowed.
Type: objectSQLMesh Audit identifier
Identifier of the audit
SQLMesh model fully qualified name
Coalesce Quality integration_id that identifies the dbt Core project
Must match regular expression:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectSQLMesh Model identifier
SQLMesh model fully qualified name
Coalesce Quality integration_id that identifies the dbt Core project
Must match regular expression:^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectSynqPath identifier
Coalesce Quality path that identifies the Coalesce Quality entity, needs to be one of supported paths
Additional Properties of any type are allowed.
Type: objectTrino table identifier
Trino catalog
Hostname of the Trino instance
Trino schema
Trino table or view
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectThe primary entities being monitored that are associated with this issue,
for example the dbt model or dbt Cloud job that a failing test is attached to.
Covers only the direct owners of the affected entities, not the owners of
downstream entities. Empty when the affected entities have no owner
assigned. Ordered as shown in the app.
An owner (person or team) responsible for an entity, as assigned in
Coalesce Quality (natively or synced from a catalog).
Identifier of the owner within the workspace. Matches the id on the
Owners API, so callers can fetch the full owner record (contacts,
source) from that API.
Display name of the owner, e.g. a team or person name.
Deep link to the owner in the Coalesce Quality app.
Additional Properties of any type are allowed.
Type: object^ISSUE_STATUS_UNSPECIFIED$
Value must be greater or equal to -2147483648 and lesser or equal to 2147483647
Set only when an actor is known: it is populated on issue_status_updated
events and left unset for system-driven transitions with no human actor
(e.g. a status implied by a monitor run). Consumers must treat it as
optional and tolerate its absence.
Carries the strongest identity the caller proved — a Coalesce Quality
email, Slack user id, or PagerDuty user id — alongside a display name.
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectMust be at least 1 characters long
Must be at least 1 characters long
Additional Properties of any type are allowed.
Type: objectMust be at least 1 characters long
Additional Properties of any type are allowed.
Type: object^VIA_UNSPECIFIED$
Value must be greater or equal to -2147483648 and lesser or equal to 2147483647
Additional Properties of any type are allowed.
Type: objectSummary of the issue, what happened and where.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: objectTest event sent during a webhook setup.
Additional Properties of any type are allowed.
Type: objectAdditional Properties of any type are allowed.
Type: object