Get Started
Monitors
Monitors Types
Incidents
Analytics
Data Warehouse Integrations
dbt Integrations
SQLMesh Integrations
Orchestration Tool Integrations
Alerting Integrations
Catalogs
Support
curl --request PUT \
--url https://developer.synq.io/api/alerts/v1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identifier": {
"fqn": "<string>"
},
"name": "<string>",
"trigger": {
"parts": [
{
"operand": "QUERY_OPERAND_UNSPECIFIED",
"parts": [
{
"identifierList": {
"identifiers": [
{
"airflowDag": {
"integrationId": "<string>",
"dagId": "<string>"
}
}
]
}
}
]
}
]
},
"targets": [
{
"email": {
"recipientEmails": [
"[email protected]"
]
}
}
],
"settings": {
"entityFailure": {
"ongoing": {
"disabled": {}
},
"severities": [
"SEVERITY_UNSPECIFIED"
],
"notifyUpstream": true,
"allowSqlTestAuditLink": true
}
},
"owner": {
"ownerPath": "<string>",
"ownershipId": "<string>"
}
}
'{
"alert": {
"trigger": {
"parts": [
{
"operand": "QUERY_OPERAND_UNSPECIFIED",
"parts": [
{
"identifierList": {
"identifiers": [
{
"airflowDag": {
"integrationId": "<string>",
"dagId": "<string>"
}
}
]
}
}
]
}
]
},
"settings": {
"entityFailure": {
"ongoing": {
"disabled": {}
},
"severities": [
"SEVERITY_UNSPECIFIED"
],
"notifyUpstream": true,
"allowSqlTestAuditLink": true
}
},
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"fqn": "<string>",
"targets": [
{
"email": {
"recipientEmails": [
"[email protected]"
]
}
}
],
"owner": {
"ownerPath": "<string>",
"ownershipId": "<string>"
},
"isDisabled": true
}
}Update
Update an existing alert configuration. The config can be identified by either ID or FQN.
curl --request PUT \
--url https://developer.synq.io/api/alerts/v1 \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"identifier": {
"fqn": "<string>"
},
"name": "<string>",
"trigger": {
"parts": [
{
"operand": "QUERY_OPERAND_UNSPECIFIED",
"parts": [
{
"identifierList": {
"identifiers": [
{
"airflowDag": {
"integrationId": "<string>",
"dagId": "<string>"
}
}
]
}
}
]
}
]
},
"targets": [
{
"email": {
"recipientEmails": [
"[email protected]"
]
}
}
],
"settings": {
"entityFailure": {
"ongoing": {
"disabled": {}
},
"severities": [
"SEVERITY_UNSPECIFIED"
],
"notifyUpstream": true,
"allowSqlTestAuditLink": true
}
},
"owner": {
"ownerPath": "<string>",
"ownershipId": "<string>"
}
}
'{
"alert": {
"trigger": {
"parts": [
{
"operand": "QUERY_OPERAND_UNSPECIFIED",
"parts": [
{
"identifierList": {
"identifiers": [
{
"airflowDag": {
"integrationId": "<string>",
"dagId": "<string>"
}
}
]
}
}
]
}
]
},
"settings": {
"entityFailure": {
"ongoing": {
"disabled": {}
},
"severities": [
"SEVERITY_UNSPECIFIED"
],
"notifyUpstream": true,
"allowSqlTestAuditLink": true
}
},
"createdAt": "2023-11-07T05:31:56Z",
"id": "<string>",
"name": "<string>",
"fqn": "<string>",
"targets": [
{
"email": {
"recipientEmails": [
"[email protected]"
]
}
}
],
"owner": {
"ownerPath": "<string>",
"ownershipId": "<string>"
},
"isDisabled": true
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
UpdateRequest updates an existing alert configuration. The config can be identified by either ID or FQN.
Human-readable name for the alert configuration.
1 - 255Query that defines which entities can trigger this alert.
Show child attributes
Show child attributes
The parts that compose this entity group query.
1Show child attributes
Show child attributes
The logical operand used to combine the query parts (AND, OR, etc.).
QUERY_OPERAND_UNSPECIFIED, QUERY_OPERAND_AND, QUERY_OPERAND_OR, QUERY_OPERAND_EXCEPT, QUERY_OPERAND_UPSTREAM, QUERY_OPERAND_DOWNSTREAM The individual query parts that make up this selection.
1A single part of a selection query.
- identifier_list
- in_data_platform
- in_dataproduct
- in_folder
- query
- unsupported
- with_annotation
- with_data_platform_type
- with_name_search
- with_type
Show child attributes
Show child attributes
Filter by specific entity identifiers.
Show child attributes
Show child attributes
Identifier is a unique reference to an entity in SYNQ 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
- airflow_task
- bigquery_table
- clickhouse_table
- custom
- databricks_table
- dataproduct
- dbt_cloud_node
- dbt_core_node
- monitor
- mysql_table
- postgres_table
- redshift_table
- snowflake_table
- sql_mesh_audit
- sql_mesh_model
- synq_path
- trino_table
Show child attributes
Show child attributes
Airflow DAG identifier
Targets where alerts will be sent.
1AlertingTarget represents a destination where alert notifications will be sent. Each target type has its own specific configuration requirements.
- email
- ms_teams
- owner
- slack
- webhook
Additional settings for the specific alert type.
- entity_failure
- schema_change
Show child attributes
Show child attributes
Alert triggered by entity failures (e.g., table failures, test failures).
Show child attributes
Show child attributes
Strategy for handling ongoing/repeated alerts.
- disabled
- schedule
- stream
Show child attributes
Show child attributes
Disabled strategy - no ongoing alerts will be sent after the initial alert. No configuration needed - alerts are simply disabled after the first one.
The severity levels that should trigger this alert.
1Severity levels that define the criticality of failures.
SEVERITY_UNSPECIFIED, SEVERITY_WARN, SEVERITY_ERROR, SEVERITY_FATAL Whether to notify upstream dependencies when this alert triggers.
Whether to allow SQL test audit links in alert notifications.
Response
Success
UpdateResponse returns the updated alert configuration.
The alert configuration that was updated.
Show child attributes
Show child attributes
Query that defines which entities can trigger this alert.
Show child attributes
Show child attributes
The parts that compose this entity group query.
1Show child attributes
Show child attributes
The logical operand used to combine the query parts (AND, OR, etc.).
QUERY_OPERAND_UNSPECIFIED, QUERY_OPERAND_AND, QUERY_OPERAND_OR, QUERY_OPERAND_EXCEPT, QUERY_OPERAND_UPSTREAM, QUERY_OPERAND_DOWNSTREAM The individual query parts that make up this selection.
1A single part of a selection query.
- identifier_list
- in_data_platform
- in_dataproduct
- in_folder
- query
- unsupported
- with_annotation
- with_data_platform_type
- with_name_search
- with_type
Show child attributes
Show child attributes
Filter by specific entity identifiers.
Show child attributes
Show child attributes
Identifier is a unique reference to an entity in SYNQ 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
- airflow_task
- bigquery_table
- clickhouse_table
- custom
- databricks_table
- dataproduct
- dbt_cloud_node
- dbt_core_node
- monitor
- mysql_table
- postgres_table
- redshift_table
- snowflake_table
- sql_mesh_audit
- sql_mesh_model
- synq_path
- trino_table
Show child attributes
Show child attributes
Airflow DAG identifier
Additional settings for the specific alert type.
- entity_failure
- schema_change
Show child attributes
Show child attributes
Alert triggered by entity failures (e.g., table failures, test failures).
Show child attributes
Show child attributes
Strategy for handling ongoing/repeated alerts.
- disabled
- schedule
- stream
Show child attributes
Show child attributes
Disabled strategy - no ongoing alerts will be sent after the initial alert. No configuration needed - alerts are simply disabled after the first one.
The severity levels that should trigger this alert.
1Severity levels that define the criticality of failures.
SEVERITY_UNSPECIFIED, SEVERITY_WARN, SEVERITY_ERROR, SEVERITY_FATAL Whether to notify upstream dependencies when this alert triggers.
Whether to allow SQL test audit links in alert notifications.
Timestamp when the alert config was created.
Unique identifier for the alert config (system-generated).
1Human-readable name for the alert configuration.
1 - 255User-provided fully qualified name for the alert config. This is a unique identifier that users can specify to reference the alert.
1 - 500List of targets where alerts will be sent.
1AlertingTarget represents a destination where alert notifications will be sent. Each target type has its own specific configuration requirements.
- email
- ms_teams
- owner
- slack
- webhook
Owner information for the alert configuration. If set, the alert is attributed to the specified owner and ownership.
Whether the alert config is currently disabled.