forked from stitchdata/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'master' into slack-coming-soon
- Loading branch information
Showing
28 changed files
with
2,688 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
59 changes: 59 additions & 0 deletions
59
...loper-files/connect/api/objects/form-properties/sources/saas/intercom-object.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
--- | ||
# -------------------------- # | ||
# USING THIS TEMPLATE # | ||
# -------------------------- # | ||
|
||
## NEED HELP USING THIS TEMPLATE? SEE: | ||
## https://docs-about-stitch-docs.netlify.com/reference/connect-templates/destination-form-property/ | ||
## FOR INSTRUCTIONS & REFERENCE INFO | ||
|
||
|
||
# -------------------------- # | ||
# CONTENT TYPE # | ||
# -------------------------- # | ||
|
||
content-type: "api-form" | ||
form-type: "source" | ||
key: "source-form-properties-intercom-object" | ||
|
||
|
||
# -------------------------- # | ||
# OBJECT INFO # | ||
# -------------------------- # | ||
|
||
title: "Intercom Source Form Property" | ||
api-type: "platform.intercom" | ||
display-name: "Intercom" | ||
|
||
source-type: "saas" | ||
docs-name: "intercom" | ||
|
||
# -------------------------- # | ||
# OBJECT ATTRIBUTES # | ||
# -------------------------- # | ||
|
||
uses-start-date: true | ||
|
||
# Only source-specific attributes need to be listed here. | ||
# The following attributes are considered common, | ||
# and therefore don't need to be listed: | ||
# anchor_time, cron_expression, frequency_in_minutes, image_version, start_date | ||
|
||
|
||
# -------------------------- # | ||
# OAUTH PROPERTIES # | ||
# -------------------------- # | ||
|
||
oauth-link: "https://developers.intercom.com/building-apps/docs/setting-up-oauth" | ||
|
||
oauth-description: "" | ||
|
||
oauth-attributes: | ||
- name: "access_token" | ||
type: "string" | ||
required: true | ||
credential: true | ||
description: | | ||
The token used to access your {{ form-property.display-name }} workspace's data via API. | ||
value: "<YOUR_API_ACCESS_TOKEN>" | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
tap: "intercom" | ||
version: "02-02-2016" | ||
|
||
name: "admins" | ||
doc-link: https://developers.intercom.io/docs/admins | ||
description: | | ||
The `{{ table.name }}` table contains info about the admins and teams in your {{ integration.display_name }} account. | ||
replication-method: "Full Table" | ||
api-method: | ||
name: listAdmins | ||
doc-link: https://developers.intercom.io/docs/list-admins | ||
|
||
attributes: | ||
- name: "id" | ||
type: "string" | ||
primary-key: true | ||
description: "The admin or team ID." | ||
foreign-key-id: "admin-id" | ||
|
||
- name: "type" | ||
type: "string" | ||
description: "The admin type. This value will be either `admin` or `team`." | ||
|
||
- name: "name" | ||
type: "string" | ||
description: "The name of the admin or team." | ||
|
||
- name: "email" | ||
type: "string" | ||
description: "The email address of the admin. This will be `NULL` for teams." | ||
|
||
- name: "away_mode_enabled" | ||
type: "boolean" | ||
description: "Indicates if the admin is currently set in away mode." | ||
|
||
- name: "away_mode_reassign" | ||
type: "boolean" | ||
description: "Indicates if the admin is set to automatically reassign new conversations to the app's default inbox." | ||
|
||
- name: "team_ids" | ||
type: "array" | ||
description: "A list of the IDs of the teams the admin is a part of." | ||
subattributes: | ||
- name: "value" | ||
type: "integer" | ||
description: "The ID of the team the admin is a part of." | ||
--- |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,106 @@ | ||
--- | ||
tap: "intercom" | ||
version: "02-02-2016" | ||
|
||
name: "companies" | ||
doc-link: https://developers.intercom.com/reference#companies | ||
description: | | ||
The `{{ table.name }}` table contains info about the companies (or commercial organizations) that use your {{ integration.display_name }} product. | ||
#### Custom Attributes | ||
If applicable, Stitch will replicate custom fields related to `{{ table.name }}` in Intercom. | ||
replication-method: "Key-based Incremental" | ||
api-method: | ||
name: scrollOverAllCompanies | ||
doc-link: https://developers.intercom.com/reference#iterating-over-all-companies | ||
|
||
attribution-window: true | ||
|
||
attributes: | ||
- name: "id" | ||
type: "string" | ||
primary-key: true | ||
description: "The Intercom-defined company ID." | ||
foreign-key-id: "company-id" | ||
|
||
- name: "updated_at" | ||
type: "date-time" | ||
replication-key: true | ||
description: "The time the company was last updated." | ||
|
||
- name: "company_id" | ||
type: "string" | ||
description: "The ID that you assigned to the company." | ||
|
||
- name: "created_at" | ||
type: "date-time" | ||
description: "The time the company was added to Intercom." | ||
|
||
- name: "remote_created_at" | ||
type: "date-time" | ||
description: "The time the company was created by you." | ||
|
||
- name: "name" | ||
type: "string" | ||
description: "The name of the company." | ||
|
||
- name: "custom_attributes" | ||
type: "object" | ||
description: "If applicable, the custom attributes you've applied to the company." | ||
|
||
- name: "session_count" | ||
type: "integer" | ||
description: "The number of recorded sessions for the company." | ||
|
||
- name: "monthly_spend" | ||
type: "number" | ||
description: "The amount of revenue the company generates for your business." | ||
|
||
- name: "user_count" | ||
type: "number" | ||
description: "The number of users in the company." | ||
|
||
- name: "plan" | ||
type: "string" | ||
description: "The name of the plan associated with the company." | ||
|
||
- name: "type" | ||
type: "string" | ||
description: "The value of this field will be `company`." | ||
|
||
- name: "segments" | ||
type: "array" | ||
description: "A list of the IDs of the segments associated with the company." | ||
subattributes: | ||
- name: "segments" | ||
type: "array" | ||
description: "A list of the IDs of the segments associated with the company." | ||
subattributes: | ||
- name: "id" | ||
type: "string" | ||
description: "The segment ID." | ||
foreign-key-id: "segment-id" | ||
|
||
- name: "type" | ||
type: "string" | ||
description: "The value of this field will be `segment`." | ||
|
||
- name: "tags" | ||
type: "array" | ||
description: "A list of the IDs of the tags associated with the company." | ||
subattributes: | ||
- name: "tags" | ||
type: "array" | ||
description: "A list of the IDs of the tags associated with the company." | ||
subattributes: | ||
- name: "id" | ||
type: "string" | ||
description: "The tag ID." | ||
foreign-key-id: "tag-id" | ||
|
||
- name: "type" | ||
type: "string" | ||
description: "The value of this field will be `tag`." | ||
--- |
43 changes: 43 additions & 0 deletions
43
_integration-schemas/intercom/v02-02-2016/company_segments.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
--- | ||
tap: "intercom" | ||
version: "02-02-2016" | ||
|
||
name: "company_segments" | ||
doc-link: https://developers.intercom.io/docs/companies | ||
description: | | ||
The `{{ table.name }}` table contains info about company segments. A segment is a group of users that are defined by a set of rules. | ||
replication-method: "Full Table" | ||
api-method: | ||
name: listSegments | ||
doc-link: https://developers.intercom.io/docs/list-segments | ||
|
||
attribution-window: true | ||
|
||
attributes: | ||
- name: "id" | ||
type: "string" | ||
primary-key: true | ||
description: "The segment ID." | ||
foreign-key-id: "company-segment-id" | ||
|
||
- name: "updated_at" | ||
type: "date-time" | ||
description: "The time the segment was last updated." | ||
|
||
- name: "created_at" | ||
type: "date-time" | ||
description: "The time the segment was created." | ||
|
||
- name: "name" | ||
type: "string" | ||
description: "The name of the segment." | ||
|
||
- name: "person_type" | ||
type: "string" | ||
description: "The type of record. This will either be `user` or `lead`." | ||
|
||
- name: "type" | ||
type: "string" | ||
description: "The value of this field will be `segment`." | ||
--- |
Oops, something went wrong.