📝 docs: update delighted source page (#27928)
* 📝 docs: update delighted source page
* docs: update delighted.md
* fixed reference to incorrect source
This commit is contained in:
committed by
GitHub
parent
086ddb750b
commit
11952ce9bd
@@ -1,36 +1,48 @@
|
||||
# Delighted
|
||||
|
||||
This page contains the setup guide and reference information for the Delighted source connector.
|
||||
This page contains the setup guide and reference information for the [Delighted](https://delighted.com/) source connector.
|
||||
|
||||
## Prerequisites
|
||||
- A Delighted API Key.
|
||||
- A desired start date and time. Only data added on and after this point will be replicated.
|
||||
|
||||
To set up the Delighted source connector, you'll need the [Delighted API key](https://app.delighted.com/docs/api#authentication).
|
||||
## Setup guide
|
||||
### Step 1: Obtain a Delighted API Key
|
||||
|
||||
## Set up the Delighted connector in Airbyte
|
||||
To set up the Delighted source connector, you'll need a Delighted API key. For detailed instructions, please refer to the
|
||||
[official Delighted documentation](https://app.delighted.com/docs/api).
|
||||
|
||||
1. [Log into your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account.
|
||||
2. Click **Sources** and then click **+ New source**.
|
||||
3. On the Set up the source page, enter the name for the Delighted connector and select **Delighted** from the Source type dropdown.
|
||||
4. For **Since**, enter the date in a Unix Timestamp format. The data added on and after this date will be replicated.
|
||||
5. For **API Key**, enter your [Delighted `API Key`](https://delighted.com/account/api).
|
||||
6. Click **Set up source**.
|
||||
### Step 2: Set up the Delighted connector in Airbyte
|
||||
|
||||
1. [Log in to your Airbyte Cloud](https://cloud.airbyte.com/workspaces) account, or navigate to the Airbyte Open Source dashboard.
|
||||
2. From the Airbyte UI, click **Sources**, then click on **+ New Source** and select **Delighted** from the list of available sources.
|
||||
3. Enter a **Source name** of your choosing.
|
||||
4. Enter your **Delighted API Key**.
|
||||
5. In the **Replication Start Date** field, enter the desired UTC date and time. Only the data added on and after this date will be replicated.
|
||||
|
||||
:::note
|
||||
If you are configuring this connector programmatically, please format your date as such: `yyyy-mm-ddThh:mm:ssZ`. For example, an input of `2022-05-30T14:50:00Z` signifies a start date of May 30th, 2022 at 2:50 PM UTC. For help converting UTC to your local time,
|
||||
[use a UTC Time Zone Converter](https://dateful.com/convert/utc).
|
||||
:::
|
||||
|
||||
6. Click **Set up source** and wait for the tests to complete.
|
||||
|
||||
## Supported sync modes
|
||||
|
||||
The Delighted source connector supports the following [ sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
|
||||
The Delighted source connector supports the following [sync modes](https://docs.airbyte.com/cloud/core-concepts#connection-sync-modes):
|
||||
|
||||
* [Full Refresh - Overwrite](https://docs.airbyte.com/understanding-airbyte/connections/full-refresh-overwrite/)
|
||||
* [Full Refresh - Append](https://docs.airbyte.com/understanding-airbyte/connections/full-refresh-append)
|
||||
* [Incremental - Append](https://docs.airbyte.com/understanding-airbyte/connections/incremental-append)
|
||||
* [Incremental - Deduped History](https://docs.airbyte.com/understanding-airbyte/connections/incremental-deduped-history)
|
||||
|
||||
## Supported Streams
|
||||
## Supported streams
|
||||
|
||||
This Source is capable of syncing the following core Streams:
|
||||
This source is capable of syncing the following core streams:
|
||||
|
||||
* [Survey Responses](https://app.delighted.com/docs/api/listing-survey-responses)
|
||||
* [People](https://app.delighted.com/docs/api/listing-people)
|
||||
* [Bounced People](https://app.delighted.com/docs/api/listing-bounced-people)
|
||||
* [People](https://app.delighted.com/docs/api/listing-people)
|
||||
* [Survey Responses](https://app.delighted.com/docs/api/listing-survey-responses)
|
||||
* [Unsubscribed People](https://app.delighted.com/docs/api/listing-unsubscribed-people)
|
||||
|
||||
## Changelog
|
||||
|
||||
Reference in New Issue
Block a user