​

Definitions

​

Event

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
workspace	string		string
event_id	string		string
event_time	string		Format: date-time
event_type	string		EVENT_TYPE_UNSPECIFIED EVENT_TYPE_PING EVENT_TYPE_ISSUE_CREATED EVENT_TYPE_ISSUE_UPDATED EVENT_TYPE_ISSUE_STATUS_UPDATED EVENT_TYPE_ISSUE_CLOSED
ping	object		Ping
issue_created	object		IssueCreated
issue_updated	object		IssueUpdated
issue_status_updated	object		IssueStatusUpdated
issue_closed	object		IssueClosed
callbacks	array		Callback

​

AirflowDagIdentifier

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
integration_id	string		string			SYNQ integration_id that identifies the Airflow instance
dag_id	string		string			Airflow dag_id that identifies the DAG

​

AirflowTaskIdentifier

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
integration_id	string		string			SYNQ integration_id that identifies the Airflow instance
dag_id	string		string			Airflow dag_id that identifies the DAG
task_id	string		string			Airflow task_id that identifies the task within the DAG

​

BigqueryTableIdentifier

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
project	string		string			BigQuery project
dataset	string		string			BigQuery dataset id
table	string		string			BigQuery table name

​

ClickhouseTableIdentifier

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
host	string		string			Clickhouse host inclusive of port
schema	string		string			Clickhouse database
table	string		string			Clickhouse table

​

CustomIdentifier

CUSTOM

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
id	string		string			Id that identifies the custom entity The Id should be unique within the custom entity Identifier.

​

DatabricksTableIdentifier

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
workspace	string		string			URL of Databricks workspace
catalog	string		string			Databricks catalog
schema	string		string			Databricks schema
table	string		string			Databricks table or view

​

DataproductIdentifier

DATAPRODUCT

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
id	string		string			Dataproduct id that identifies the Dataproduct

​

DbtCloudNodeIdentifier

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
project_id	string		string			Your dbt Cloud project id
account_id	string		string			Your dbt Cloud account id
node_id	string		string			Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

​

DbtCoreNodeIdentifier

DBT

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
integration_id	string		string			SYNQ integration_id that identifies the dbt Core project
node_id	string		string			Dbt node_id that identifies one of dbt DAG nodes (model, test, etc)

​

Identifier

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.

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
dbt_core_node	object		DbtCoreNodeIdentifier			Dbt node that identifies one of dbt DAG nodes (model, test, etc) in dbt Core project
dbt_cloud_node	object		DbtCloudNodeIdentifier			Dbt node that identifies one of dbt DAG nodes (model, test, etc) in dbt Cloud project
bigquery_table	object		BigqueryTableIdentifier			BigQuery table identifier
snowflake_table	object		SnowflakeTableIdentifier			Snowflake table identifier
redshift_table	object		RedshiftTableIdentifier			Redshift table identifier
postgres_table	object		PostgresTableIdentifier			Postgres table identifier
mysql_table	object		MysqlTableIdentifier			Mysql table identifier
clickhouse_table	object		ClickhouseTableIdentifier			Clickhouse table identifier
databricks_table	object		DatabricksTableIdentifier			Databricks table identifier
airflow_dag	object		AirflowDagIdentifier			Airflow DAG identifier
airflow_task	object		AirflowTaskIdentifier			Airflow task identifier within a given DAG
custom	object		CustomIdentifier			Custom identifier to be used with all custom created entities
dataproduct	object		DataproductIdentifier			Dataproduct identifier
synq_path	object		SynqPathIdentifier			SynqPath identifier

​

MysqlTableIdentifier

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
host	string		string			Mysql host inclusive of port
schema	string		string			Mysql database
table	string		string			Mysql table

​

PostgresTableIdentifier

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
host	string		string			Postgres host inclusive of port
database	string		string			Postgres database
schema	string		string			Postgres schema
table	string		string			Postgres table

​

RedshiftTableIdentifier

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
cluster	string		string			Redshift cluster
database	string		string			Redshift database
schema	string		string			Redshift schema
table	string		string			Redshift table

​

SnowflakeTableIdentifier

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
account	string		string			Snowflake account
database	string		string			Snowflake database
schema	string		string			Snowflake schema
table	string		string			Snowflake table

​

SynqPathIdentifier

SYNQ PATH

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
path	string		string			SYNQ path that identifies the SYNQ entity, needs to be one of supported paths

​

Actor

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
name	string		string
slack	object		SlackUser
email	object		EmailUser
pagerduty	object		PagerdutyUser

​

EmailUser

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
user_email	string		string

​

PagerdutyUser

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
user_id	string		string

​

SlackUser

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
user_id	string		string

​

IssuesCommand

Not to be used directly. Use the IssuesService instead when calling via API.

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
workspace	string		string
mark_investigating	object		MarkInvestigatingRequest
mark_fixed	object		MarkFixedRequest
mark_expected	object		MarkExpectedRequest
mark_no_action_needed	object		MarkNoActionNeededRequest
post_comment	object		PostCommentRequest

​

MarkExpectedRequest

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
issue_id	string		string			ID of the issue to mark as expected.
actor	object		Actor			Actor marking the issue as expected.

​

MarkFixedRequest

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
issue_id	string		string			ID of the issue to mark as fixed.
actor	object		Actor			Actor marking the issue as fixed.

​

MarkInvestigatingRequest

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
issue_id	string		string			ID of the issue to mark as investigating.
actor	object		Actor			Actor marking the issue as investigating.

​

MarkNoActionNeededRequest

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
issue_id	string		string			ID of the issue to mark as no action needed.
actor	object		Actor			Actor marking the issue as no action needed.

​

PostCommentRequest

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
issue_id	string		string			ID of the issue to post a comment on.
actor	object		Actor			Actor posting the comment.
comment	string		string			Comment to post.

​

Callback

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
url	string		string
action_name	string		string
issues_command	object		IssuesCommand

​

IssueClosed

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
issue	object		IssueSummary

​

IssueCreated

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
issue	object		IssueSummary

​

IssueStatusUpdated

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
issue	object		IssueSummary

​

IssueSummary

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
issue_id	string		string
issue_group_id	string		string
issue_url	string		string
title	string		string			Summary of the issue, what happened and where.
description	string		string			Detailed description of the issue.
trigger_entity	object		IssueSummary.IssueEntity			Entity which triggered the issue.
directly_affected_entities	array		IssueSummary.IssueEntity			Entities directly affected by the issue, not considering downstream ones.
started_at	string		Format: date-time			Time when the issue was triggered.
ended_at	string		Format: date-time			Time when the issue was closed.
trigger_run_id	string		string
trigger_name	string		string
trigger_message	string		string
status	string		ISSUE_STATUS_UNSPECIFIED ISSUE_STATUS_INVESTIGATING ISSUE_STATUS_EXPECTED ISSUE_STATUS_FIXED ISSUE_STATUS_NO_ACTION_NEEDED

​

IssueSummary.IssueEntity

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
name	string		string
type_name	string		string
identifier	object		Identifier
folder	string		string
entity_url	string		string

​

IssueUpdated

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
issue	object		IssueSummary

​

Ping

Test event sent during a webhook setup.

​

Type: object

Property	Type	Required	Possible values	Deprecated	Default	Description	Examples
message	string		string

---

Markdown generated with jsonschema-markdown.