1
0
mirror of synced 2025-12-23 21:03:15 -05:00

source-appcues contribution from btkcodedev (#45102)

Co-authored-by: Octavia Squidington III <octavia-squidington-iii@users.noreply.github.com>
Co-authored-by: Natik Gadzhi <natik@respawn.io>
This commit is contained in:
btkcodedev
2024-09-17 04:08:54 +05:30
committed by GitHub
parent 368b5c2fdd
commit b6deeb359c
6 changed files with 3094 additions and 0 deletions

View File

@@ -0,0 +1,39 @@
# Appcues
This directory contains the manifest-only connector for `source-appcues`.
## Documentation reference:
Visit `https://api.appcues.com/v2/docs` for API documentation
## Authentication setup
Appcues uses basic http auth that uses username and password
Visit settings page for generating secrets and copy account id `https://studio.appcues.com/settings/`
## 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-appcues:dev`) that you can use to test the connector locally.
```bash
airbyte-ci connectors --name=source-appcues build
```
### Test
This will run the acceptance tests for the connector.
```bash
airbyte-ci connectors --name=source-appcues test
```

View File

@@ -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-appcues: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"

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 7.7 KiB

File diff suppressed because it is too large Load Diff

View File

@@ -0,0 +1,35 @@
metadataSpecVersion: "1.0"
data:
allowedHosts:
hosts:
- api.appcues.com
registryOverrides:
oss:
enabled: true
cloud:
enabled: true
remoteRegistries:
pypi:
enabled: false
packageName: airbyte-source-appcues
connectorBuildOptions:
baseImage: docker.io/airbyte/source-declarative-manifest:4.6.2@sha256:f5fcd3d4703b7590b6166a7853c5ed1686731607cd30a159a8c24e2fe2c1ee98
connectorSubtype: api
connectorType: source
definitionId: 3bab735a-e108-4c94-ab3f-414e3447b409
dockerImageTag: 0.0.1
dockerRepository: airbyte/source-appcues
githubIssueLabel: source-appcues
icon: icon.svg
license: MIT
name: Appcues
releaseDate: 2024-09-03
releaseStage: alpha
supportLevel: community
documentationUrl: https://docs.airbyte.com/integrations/sources/appcues
tags:
- language:manifest-only
- cdk:low-code
ab_internal:
ql: 100
sl: 100

View File

@@ -0,0 +1,50 @@
# Appcues
This page guides you through setting up the Appcues source connector to sync data for the [Appcues](https://studio.appcues.com).
Visit `https://api.appcues.com/v2/docs` for referencing API documentation.
## Prerequisite
To set up the Appcues source connector, you'll need your Appcues [`API Key` and `API secret`](https://studio.appcues.com/settings/keys).
## Set up the Appcues source connector
1. Log into your [Airbyte Cloud](https://cloud.airbyte.com/workspaces) or Airbyte Open Source account.
2. Click **Sources** and then click **+ New source**.
3. On the Set up the source page, select **Appcues** from the Source type dropdown.
4. Enter a name for your source.
5. For **API Key** and **Secret Key**, enter the Appcues [API key and API secret key](https://studio.appcues.com/settings/keys).
6. For **Replication Start Date**, enter the date in `YYYY-MM-DDTHH:mm:ssZ` format. The data added on and after this date will be replicated. If this field is blank, Airbyte will replicate all data.
7. Click **Set up source**.
## Configuration
| Input | Type | Description | Default Value |
|-------|------|-------------|---------------|
| `username` | `string` | Username. | |
| `password` | `string` | Password. | |
| `account_id` | `string` | Account ID. Account ID of Appcues found in account settings page (https://studio.appcues.com/settings/account) | |
| `start_date` | `string` | Start date. | |
## Streams
| Stream Name | Primary Key | Pagination | Supports Full Sync | Supports Incremental |
|-------------|-------------|------------|---------------------|----------------------|
| launchpads | id | No pagination | ✅ | ✅ |
| flows | id | No pagination | ✅ | ✅ |
| banners | id | No pagination | ✅ | ✅ |
| checklists | id | No pagination | ✅ | ✅ |
| pins | id | No pagination | ✅ | ✅ |
| tags | id | No pagination | ✅ | ✅ |
| segments | id | No pagination | ✅ | ✅ |
## Changelog
<details>
<summary>Expand to review</summary>
| Version | Date |PR | Subject |
|------------------|------------|-----|----------------|
| 0.0.1 | 2024-09-03 | [45102](https://github.com/airbytehq/airbyte/pull/45102) | Initial release by [@btkcodedev](https://github.com/btkcodedev) via Connector Builder|
</details>