reverse-etl
reverse-etl — 9 operations (GET /v1/apps/{appId}/reverse-etl, POST /v1/apps/{appId}/reverse-etl, POST /v1/apps/{appId}/reverse-etl/test-connection, …). Generated from the OpenAPI 3.1.0 contract.
Base URL: https://api.pushizo.com · Tag: reverse-etl · Interactive docs (Scalar)
Operations
| Method | Path | Operation |
|---|---|---|
GET | /v1/apps/{appId}/reverse-etl | Imports from warehouses |
POST | /v1/apps/{appId}/reverse-etl | Create an import |
POST | /v1/apps/{appId}/reverse-etl/test-connection | Test the connection without saving |
GET | /v1/apps/{appId}/reverse-etl/{syncId} | Import details |
PATCH | /v1/apps/{appId}/reverse-etl/{syncId} | Update an import |
DELETE | /v1/apps/{appId}/reverse-etl/{syncId} | Delete an import |
POST | /v1/apps/{appId}/reverse-etl/{syncId}/test | Test the connection of a saved import |
POST | /v1/apps/{appId}/reverse-etl/{syncId}/run | Import now |
GET | /v1/apps/{appId}/reverse-etl/{syncId}/runs | Import history |
Details
Imports from warehouses
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ReverseEtlSyncList
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].app_id | string | Yes | |
data[].name | string | Yes | |
data[].source | enum | Yes | Values: "snowflake", "bigquery", "postgres", "mysql", "s3", "google_sheets", "clickhouse", "sqlserver", "trino", "athena", "elasticsearch", "kafka", "pubsub" |
data[].target | enum | Yes | Values: "event", "user" |
data[].config | map<string, any> | Yes | |
data[].credentials_hint | string | Yes | |
data[].schedule | enum | Yes | Values: "every_5_minutes", "hourly", "daily" |
data[].enabled | boolean | Yes | |
data[].status | enum | Yes | Values: "active", "paused", "failing" |
data[].cursor | string | null | Yes | |
data[].consecutive_failures | integer | Yes | |
data[].last_error | string | null | Yes | |
data[].last_run_at | string | null | Yes | |
data[].last_success_at | string | null | Yes | |
data[].next_run_at | string | null | Yes | |
data[].created_at | string | Yes | |
data[].updated_at | string | Yes |
Example response:
{
"data": [
{
"name": "Sipariş bildirimleri",
"target": "event",
"enabled": true,
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"source": "snowflake",
"config": {
"key": "örnek"
},
"credentials_hint": "örnek",
"schedule": "every_5_minutes",
"cursor": "eyJpZCI6Im1zZ18wMUpE…",
"consecutive_failures": 1,
"last_error": "örnek",
"last_run_at": "örnek",
"last_success_at": "örnek",
"next_run_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}
]
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/reverse-etl" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Create an import
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: ReverseEtlCreate
Type: ReverseEtlCreate
Example:
{
"name": "Sipariş bildirimleri",
"target": "event",
"schedule": "every_5_minutes",
"source": "snowflake",
"config": {
"account": "değer",
"user": "değer",
"database": "değer",
"schema": "değer",
"warehouse": "değer",
"query": "ayse",
"mapping": {
"external_id_column": "değer",
"event_name": "purchase"
},
"role": "değer"
},
"credentials": {
"private_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
},
"enabled": true
}Responses
201 — Success.
Schema: ReverseEtlSync
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
source | enum | Yes | Values: "snowflake", "bigquery", "postgres", "mysql", "s3", "google_sheets", "clickhouse", "sqlserver", "trino", "athena", "elasticsearch", "kafka", "pubsub" |
target | enum | Yes | Values: "event", "user" |
config | map<string, any> | Yes | |
credentials_hint | string | Yes | |
schedule | enum | Yes | Values: "every_5_minutes", "hourly", "daily" |
enabled | boolean | Yes | |
status | enum | Yes | Values: "active", "paused", "failing" |
cursor | string | null | Yes | |
consecutive_failures | integer | Yes | |
last_error | string | null | Yes | |
last_run_at | string | null | Yes | |
last_success_at | string | null | Yes | |
next_run_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"target": "event",
"enabled": true,
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"source": "snowflake",
"config": {
"key": "örnek"
},
"credentials_hint": "örnek",
"schedule": "every_5_minutes",
"cursor": "eyJpZCI6Im1zZ18wMUpE…",
"consecutive_failures": 1,
"last_error": "örnek",
"last_run_at": "örnek",
"last_success_at": "örnek",
"next_run_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/reverse-etl" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"target": "event",
"schedule": "every_5_minutes",
"source": "snowflake",
"config": {
"account": "değer",
"user": "değer",
"database": "değer",
"schema": "değer",
"warehouse": "değer",
"query": "ayse",
"mapping": {
"external_id_column": "değer",
"event_name": "purchase"
},
"role": "değer"
},
"credentials": {
"private_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
},
"enabled": true
}'Test the connection without saving
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: ReverseEtlConnectionTest
Type: ReverseEtlConnectionTest
Example:
{
"source": "snowflake",
"config": {
"account": "değer",
"user": "değer",
"database": "değer",
"schema": "değer",
"warehouse": "değer",
"query": "ayse",
"mapping": {
"external_id_column": "değer",
"event_name": "purchase"
},
"role": "değer"
},
"credentials": {
"private_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}Responses
200 — Success.
Schema: WarehouseConnectionResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | |
detail | string | null | Yes | |
error | object | null | Yes |
Example response:
{
"ok": true,
"detail": "örnek",
"error": {
"code": "örnek",
"message": "Takip bağlantısı içeride"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/reverse-etl/test-connection" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"source": "snowflake",
"config": {
"account": "değer",
"user": "değer",
"database": "değer",
"schema": "değer",
"warehouse": "değer",
"query": "ayse",
"mapping": {
"external_id_column": "değer",
"event_name": "purchase"
},
"role": "değer"
},
"credentials": {
"private_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
}'Import details
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
syncId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ReverseEtlSync
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
source | enum | Yes | Values: "snowflake", "bigquery", "postgres", "mysql", "s3", "google_sheets", "clickhouse", "sqlserver", "trino", "athena", "elasticsearch", "kafka", "pubsub" |
target | enum | Yes | Values: "event", "user" |
config | map<string, any> | Yes | |
credentials_hint | string | Yes | |
schedule | enum | Yes | Values: "every_5_minutes", "hourly", "daily" |
enabled | boolean | Yes | |
status | enum | Yes | Values: "active", "paused", "failing" |
cursor | string | null | Yes | |
consecutive_failures | integer | Yes | |
last_error | string | null | Yes | |
last_run_at | string | null | Yes | |
last_success_at | string | null | Yes | |
next_run_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"target": "event",
"enabled": true,
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"source": "snowflake",
"config": {
"key": "örnek"
},
"credentials_hint": "örnek",
"schedule": "every_5_minutes",
"cursor": "eyJpZCI6Im1zZ18wMUpE…",
"consecutive_failures": 1,
"last_error": "örnek",
"last_run_at": "örnek",
"last_success_at": "örnek",
"next_run_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/reverse-etl/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Update an import
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
syncId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Request body (required)
Schema: UpdateReverseEtlDto
| Field | Type | Required | Description |
|---|---|---|---|
name | string | No | Length: 1–100 |
schedule | enum | No | Values: "every_5_minutes", "hourly", "daily" |
enabled | boolean | No | |
config | map<string, any> | No | |
credentials | map<string, any> | No |
Example:
{
"name": "Sipariş bildirimleri",
"enabled": true,
"schedule": "every_5_minutes",
"config": {
"key": "örnek"
},
"credentials": {
"key": "örnek"
}
}Responses
200 — Success.
Schema: ReverseEtlSync
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
app_id | string | Yes | |
name | string | Yes | |
source | enum | Yes | Values: "snowflake", "bigquery", "postgres", "mysql", "s3", "google_sheets", "clickhouse", "sqlserver", "trino", "athena", "elasticsearch", "kafka", "pubsub" |
target | enum | Yes | Values: "event", "user" |
config | map<string, any> | Yes | |
credentials_hint | string | Yes | |
schedule | enum | Yes | Values: "every_5_minutes", "hourly", "daily" |
enabled | boolean | Yes | |
status | enum | Yes | Values: "active", "paused", "failing" |
cursor | string | null | Yes | |
consecutive_failures | integer | Yes | |
last_error | string | null | Yes | |
last_run_at | string | null | Yes | |
last_success_at | string | null | Yes | |
next_run_at | string | null | Yes | |
created_at | string | Yes | |
updated_at | string | Yes |
Example response:
{
"name": "Sipariş bildirimleri",
"target": "event",
"enabled": true,
"status": "active",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"app_id": "app_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"source": "snowflake",
"config": {
"key": "örnek"
},
"credentials_hint": "örnek",
"schedule": "every_5_minutes",
"cursor": "eyJpZCI6Im1zZ18wMUpE…",
"consecutive_failures": 1,
"last_error": "örnek",
"last_run_at": "örnek",
"last_success_at": "örnek",
"next_run_at": "örnek",
"created_at": "örnek",
"updated_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X PATCH "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/reverse-etl/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Sipariş bildirimleri",
"enabled": true,
"schedule": "every_5_minutes",
"config": {
"key": "örnek"
},
"credentials": {
"key": "örnek"
}
}'Delete an import
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
syncId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: Ok
| Field | Type | Required | Description |
|---|---|---|---|
ok | true | Yes |
Example response:
{
"ok": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X DELETE "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/reverse-etl/id_01JD3W5Q7X9K2M4N6P8R0T1V3W" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Test the connection of a saved import
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
syncId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: WarehouseConnectionResult
| Field | Type | Required | Description |
|---|---|---|---|
ok | boolean | Yes | |
detail | string | null | Yes | |
error | object | null | Yes |
Example response:
{
"ok": true,
"detail": "örnek",
"error": {
"code": "örnek",
"message": "Takip bağlantısı içeride"
}
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/reverse-etl/id_01JD3W5Q7X9K2M4N6P8R0T1V3W/test" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Import now
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
syncId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
202 — Success.
Schema: ReverseEtlRun
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | |
sync_id | string | Yes | |
trigger | enum | Yes | Values: "schedule", "manual" |
status | enum | Yes | Values: "queued", "running", "succeeded", "failed" |
row_count | integer | Yes | |
attempt | integer | Yes | |
error | string | null | Yes | |
started_at | string | null | Yes | |
finished_at | string | null | Yes | |
duration_ms | integer | null | Yes | |
created_at | string | Yes |
Example response:
{
"status": "queued",
"id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"sync_id": "run_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"trigger": "schedule",
"row_count": 1,
"attempt": 1,
"error": "örnek",
"started_at": "örnek",
"finished_at": "örnek",
"duration_ms": 1,
"created_at": "örnek"
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X POST "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/reverse-etl/id_01JD3W5Q7X9K2M4N6P8R0T1V3W/run" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"Import history
Authentication: API key — scope admin (admin includes every scope).
Parameters
| Name | In | Type | Required | Description | Example |
|---|---|---|---|---|---|
syncId | path | string | Yes | "id_01JD3W5Q7X9K2M4N6P8R0T1V3W" | |
limit | query | integer | No | Default: 50; Range: 1–200 | 50 |
cursor | query | string | No | Length: 1–∞ | "eyJpZCI6Im1zZ18wMUpE…" |
appId | path | string | Yes | "app_01JD3W5Q7X9K2M4N6P8R0T1V3W" |
Responses
200 — Success.
Schema: ReverseEtlRunPage
| Field | Type | Required | Description |
|---|---|---|---|
data | array<object> | Yes | |
data[].id | string | Yes | |
data[].sync_id | string | Yes | |
data[].trigger | enum | Yes | Values: "schedule", "manual" |
data[].status | enum | Yes | Values: "queued", "running", "succeeded", "failed" |
data[].row_count | integer | Yes | |
data[].attempt | integer | Yes | |
data[].error | string | null | Yes | |
data[].started_at | string | null | Yes | |
data[].finished_at | string | null | Yes | |
data[].duration_ms | integer | null | Yes | |
data[].created_at | string | Yes | |
next_cursor | string | null | Yes | |
has_more | boolean | Yes |
Example response:
{
"data": [
{
"status": "queued",
"id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"sync_id": "id_01JD3W5Q7X9K2M4N6P8R0T1V3W",
"trigger": "schedule",
"row_count": 1,
"attempt": 1,
"error": "örnek",
"started_at": "örnek",
"finished_at": "örnek",
"duration_ms": 1,
"created_at": "örnek"
}
],
"next_cursor": "eyJpZCI6Im1zZ18wMUpE…",
"has_more": true
}Errors use the common envelope (error.code, message, details, request_id): error catalog. Every response carries X-RateLimit-* headers (rate limits).
Examples
curl -X GET "https://api.pushizo.com/v1/apps/app_01JD3W5Q7X9K2M4N6P8R0T1V3W/reverse-etl/id_01JD3W5Q7X9K2M4N6P8R0T1V3W/runs?limit=50" \
-H "Authorization: Bearer $PUSHIZO_API_KEY"wallet
wallet — 12 operations (GET /v1/apps/{appId}/wallet/config, PUT /v1/apps/{appId}/wallet/config, GET /v1/apps/{appId}/wallet/templates, …). Generated from the OpenAPI 3.1.0 contract.
setup
setup — 2 operations (GET /v1/apps/{appId}/setup/status, GET /v1/apps/{appId}/setup/snippet). Generated from the OpenAPI 3.1.0 contract.