Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions airbyte-integrations/connectors/source-ticktick/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# ticktick
This directory contains the manifest-only connector for `source-ticktick`.

Source for the ticktick openapi endpoint at https://developer.ticktick.com/

## Usage
There are multiple ways to use this connector:
- You can use this connector as any other connector in Airbyte Marketplace.
- You can load this connector in `pyairbyte` using `get_source`!
- You can open this connector in Connector Builder, edit it, and publish to your workspaces.

Please refer to the manifest-only connector documentation for more details.

## Local Development
We recommend you use the Connector Builder to edit this connector.

But, if you want to develop this connector locally, you can use the following steps.

### Environment Setup
You will need `airbyte-ci` installed. You can find the documentation [here](airbyte-ci).

### Build
This will create a dev image (`source-ticktick:dev`) that you can use to test the connector locally.
```bash
airbyte-ci connectors --name=source-ticktick build
```

### Test
This will run the acceptance tests for the connector.
```bash
airbyte-ci connectors --name=source-ticktick test
```

Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# See [Connector Acceptance Tests](https://docs.airbyte.com/connector-development/testing-connectors/connector-acceptance-tests-reference)
# for more information about how to configure these tests
connector_image: airbyte/source-ticktick:dev
acceptance_tests:
spec:
tests:
- spec_path: "manifest.yaml"
connection:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
discovery:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
basic_read:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
incremental:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
full_refresh:
bypass_reason: "This is a builder contribution, and we do not have secrets at this time"
12 changes: 12 additions & 0 deletions airbyte-integrations/connectors/source-ticktick/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
232 changes: 232 additions & 0 deletions airbyte-integrations/connectors/source-ticktick/manifest.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,232 @@
version: 6.48.15

type: DeclarativeSource

description: Source for the ticktick openapi endpoint at https://developer.ticktick.com/

check:
type: CheckStream
stream_names:
- projects

definitions:
streams:
projects:
type: DeclarativeStream
name: projects
primary_key:
- id
retriever:
type: SimpleRetriever
requester:
$ref: "#/definitions/base_requester"
path: /open/v1/project
http_method: GET
record_selector:
type: RecordSelector
extractor:
type: DpathExtractor
field_path: []
decoder:
type: JsonDecoder
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/projects"
tasks:
type: DeclarativeStream
name: tasks
primary_key:
- id
retriever:
type: SimpleRetriever
requester:
$ref: "#/definitions/base_requester"
path: /open/v1/project/{{ stream_partition['parent_id'] }}/data
http_method: GET
record_selector:
type: RecordSelector
extractor:
type: DpathExtractor
field_path:
- tasks
partition_router:
type: SubstreamPartitionRouter
parent_stream_configs:
- type: ParentStreamConfig
parent_key: id
partition_field: parent_id
stream:
$ref: "#/definitions/streams/projects"
decoder:
type: JsonDecoder
schema_loader:
type: InlineSchemaLoader
schema:
$ref: "#/schemas/tasks"
base_requester:
type: HttpRequester
url_base: https://api.ticktick.com
authenticator:
type: BearerAuthenticator
api_token: "{{ config[\"api_key\"] }}"

streams:
- $ref: "#/definitions/streams/projects"
- $ref: "#/definitions/streams/tasks"

spec:
type: Spec
connection_specification:
type: object
$schema: http://json-schema.org/draft-07/schema#
required:
- api_key
properties:
api_key:
type: string
order: 0
title: API Key
airbyte_secret: true
additionalProperties: true

metadata:
autoImportSchema:
projects: true
tasks: true
testedStreams:
projects:
streamHash: 78b3cae4a919eb24d192a3b747f4d3df856f7294
hasResponse: true
responsesAreSuccessful: true
hasRecords: true
primaryKeysArePresent: true
primaryKeysAreUnique: true
tasks:
streamHash: c78dbe7a9ef32ba08448acd4dbf94dd6de83d8e9
hasResponse: true
responsesAreSuccessful: true
hasRecords: true
primaryKeysArePresent: true
primaryKeysAreUnique: true
assist: {}

schemas:
projects:
type: object
$schema: http://json-schema.org/schema#
additionalProperties: true
properties:
closed:
type:
- boolean
- "null"
color:
type:
- string
- "null"
groupId:
type:
- string
- "null"
id:
type: string
kind:
type:
- string
- "null"
name:
type:
- string
- "null"
permission:
type:
- string
- "null"
sortOrder:
type:
- number
- "null"
viewMode:
type:
- string
- "null"
required:
- id
tasks:
type: object
$schema: http://json-schema.org/schema#
additionalProperties: true
properties:
columnId:
type:
- string
- "null"
content:
type:
- string
- "null"
desc:
type:
- string
- "null"
dueDate:
type:
- string
- "null"
etag:
type:
- string
- "null"
id:
type: string
isAllDay:
type:
- boolean
- "null"
kind:
type:
- string
- "null"
priority:
type:
- number
- "null"
projectId:
type:
- string
- "null"
repeatFlag:
type:
- string
- "null"
sortOrder:
type:
- number
- "null"
startDate:
type:
- string
- "null"
status:
type:
- number
- "null"
tags:
type:
- array
- "null"
items:
type:
- string
- "null"
timeZone:
type:
- string
- "null"
title:
type:
- string
- "null"
required:
- id
35 changes: 35 additions & 0 deletions airbyte-integrations/connectors/source-ticktick/metadata.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
metadataSpecVersion: "1.0"
data:
allowedHosts:
hosts:
- "api.ticktick.com"
registryOverrides:
oss:
enabled: true
cloud:
enabled: true
remoteRegistries:
pypi:
enabled: false
packageName: airbyte-source-ticktick
connectorBuildOptions:
baseImage: docker.io/airbyte/source-declarative-manifest:6.60.7@sha256:f836a14371bfc1dd303d163e4ddc5794fd2217ea9e985c4dba16e3ed36d3f14b
connectorSubtype: api
connectorType: source
definitionId: 6b9d55ac-d9fa-4444-9ee9-81c6c97f8bdb
dockerImageTag: 0.0.1
dockerRepository: airbyte/source-ticktick
githubIssueLabel: source-ticktick
icon: icon.svg
license: MIT
name: ticktick
releaseDate: 2025-08-05
releaseStage: alpha
supportLevel: community
documentationUrl: https://docs.airbyte.com/integrations/sources/ticktick
tags:
- language:manifest-only
- cdk:low-code
ab_internal:
ql: 100
sl: 100
25 changes: 25 additions & 0 deletions docs/integrations/sources/ticktick.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# ticktick
Source for the ticktick openapi endpoint at https://developer.ticktick.com/

## Configuration

| Input | Type | Description | Default Value |
|-------|------|-------------|---------------|
| `api_key` | `string` | API Key optained from running the workflow [get access token](https://developer.ticktick.com/api#/openapi?id=get-access-token) | |

## Streams
| Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental |
|-------------|-------------|------------|---------------------|----------------------|
| projects | id | No pagination | ✅ | ❌ |
| tasks | id | No pagination | ✅ | ❌ |

## Changelog

<details>
<summary>Expand to review</summary>

| Version | Date | Pull Request | Subject |
|------------------|-------------------|--------------|----------------|
| 0.0.1 | 2025-08-05 | | Initial release by [@luutuankiet](https://github.com/luutuankiet) via Connector Builder |

</details>
Loading