diff --git a/docs/integrations/sources/kustomer.md b/docs/integrations/sources/kustomer.md new file mode 100644 index 0000000000000..2d0e27309a628 --- /dev/null +++ b/docs/integrations/sources/kustomer.md @@ -0,0 +1,41 @@ +# Kustomer + +## Sync overview + +The Kustomer source supports both Full Refresh and Incremental syncs. You can choose if this connector will copy only the new or updated data, or all rows in the tables and columns you set up for replication, every time a sync is run. + +This source can sync data for the [Kustomer API](https://developer.kustomer.com/kustomer-api-docs). + +This Source Connector is based on a [Singer tap](https://github.com/singer-io/tap-kustomer). + +### Output schema + +This Source is capable of syncing the following core Streams: + +- [Conversations](https://developer.kustomer.com/kustomer-api-docs/reference/conversations) +- [Customers](https://developer.kustomer.com/kustomer-api-docs/reference/customers) +- [KObjects](https://developer.kustomer.com/kustomer-api-docs/reference/kobjects-custom-objects) +- [Messages](https://developer.kustomer.com/kustomer-api-docs/reference/messages) +- [Notes](https://developer.kustomer.com/kustomer-api-docs/reference/notes) +- [Shortcuts](https://developer.kustomer.com/kustomer-api-docs/reference/shortcuts) +- [Tags](https://developer.kustomer.com/kustomer-api-docs/reference/tags-knowledge-base) +- [Teams](https://developer.kustomer.com/kustomer-api-docs/reference/teams) +- [Users](https://developer.kustomer.com/kustomer-api-docs/reference/users) + +### Features + +| Feature | Supported?\(Yes/No\) | Notes | +| :------------------------ | :------------------- | :---- | +| Full Refresh Sync | Yes | | +| Incremental - Append Sync | Yes | | +| Namespaces | No | | + +### Performance considerations + +Kustomer has some [rate limit restrictions](https://developer.kustomer.com/kustomer-api-docs/reference/rate-limiting). + +## Changelog + +| Version | Date | Pull Request | Subject | +| :------ | :--------- | :----------------------------------------------------- | :---------------------------- | +| 0.1.0 | 2021-07-22 | [4550](https://github.com/airbytehq/airbyte/pull/4550) | Add Kustomer Source Connector |