From 1ea45d2074800b46d0c047589ead53034a6d725e Mon Sep 17 00:00:00 2001 From: Paul Yoo Date: Mon, 13 Jul 2020 14:59:48 -0600 Subject: [PATCH 1/5] calixa docs + make catalog --- src/_data/catalog/destination_categories.yml | 2 +- src/_data/catalog/destinations.yml | 90 +++++++++++++++---- src/_data/catalog/source_categories.yml | 2 +- src/_data/catalog/sources.yml | 2 +- .../destinations/catalog/calixa/index.md | 68 ++++++++++++++ 5 files changed, 142 insertions(+), 22 deletions(-) create mode 100644 src/connections/destinations/catalog/calixa/index.md diff --git a/src/_data/catalog/destination_categories.yml b/src/_data/catalog/destination_categories.yml index 922e8a7ee0..7083347dff 100644 --- a/src/_data/catalog/destination_categories.yml +++ b/src/_data/catalog/destination_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT -# destination categories last updated 2020-07-09 +# destination categories last updated 2020-07-13 items: - display_name: Email Marketing slug: email-marketing diff --git a/src/_data/catalog/destinations.yml b/src/_data/catalog/destinations.yml index 2aaaaab5a1..3964bc4121 100644 --- a/src/_data/catalog/destinations.yml +++ b/src/_data/catalog/destinations.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT -# destination data last updated 2020-07-09 +# destination data last updated 2020-07-13 items: - display_name: ActiveCampaign slug: activecampaign @@ -3971,6 +3971,58 @@ items: server: true previous_names: - ByteGain +- display_name: Calixa + slug: calixa + name: catalog/destinations/calixa + description: Manage all of your customers in one place + hidden: false + url: connections/destinations/catalog/calixa + status: PUBLIC_BETA + logo: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/bd0cc6cc-908e-425f-82b3-6f309eb49484.svg + mark: + url: >- + https://public-segment-devcenter-production.s3.amazonaws.com/67ec1978-b686-4ce1-b395-ee00a3f6d271.svg + categories: + - CRM + - Raw Data + - Analytics + components: + - type: CLOUD + platforms: + browser: true + server: true + mobile: true + browserUnbundlingSupported: false + browserUnbundlingPublic: false + methods: + alias: false + group: true + identify: true + page_view: false + track: true + settings: + - name: apiKey + display_name: API Key + type: STRING + deprecated: false + required: true + string_validators: + regexp: '^.{8,}$' + description: You can find your API in the Calixa Account page. + settings: [] + connection_modes: + device: + web: false + mobile: false + server: false + cloud: + web: false + mobile: true + server: true + previous_names: + - Calixa - display_name: Callingly slug: callingly name: catalog/destinations/callingly @@ -12666,6 +12718,13 @@ items: required: false description: Map your Segment properties to the Marketo Activity Fields settings: + - name: primaryKey + display_name: Set as Primary Key + type: BOOLEAN + deprecated: false + required: false + description: Mark this property as the Primary field in Marketo. + settings: [] - name: segmentProperty display_name: Segment Property Name type: STRING @@ -12701,13 +12760,6 @@ items: - date description: Enter the Marketo Field type. settings: [] - - name: primaryKey - display_name: Set as Primary Key - type: BOOLEAN - deprecated: false - required: false - description: Mark this property as the Primary field in Marketo. - settings: [] - name: event display_name: Segment Event Name type: STRING @@ -15730,10 +15782,10 @@ items: status: PUBLIC_BETA logo: url: >- - https://public-segment-devcenter-production.s3.amazonaws.com/6a63f1bb-861f-49e9-b4b0-a5ac48f7a29a.svg + https://public-segment-devcenter-production.s3.amazonaws.com/73c17817-b742-409a-9a87-1b2c8aa9ffb5.svg mark: url: >- - https://public-segment-devcenter-production.s3.amazonaws.com/59955fa5-91be-4206-96e5-08426d83021a.svg + https://public-segment-devcenter-production.s3.amazonaws.com/01bc7414-9b2a-45a7-a7e9-ee75d3c504ae.svg categories: - Advertising components: [] @@ -16652,6 +16704,15 @@ items: required: false description: Map your Segment properties to Responsys Columns settings: + - name: columns + display_name: Segment Property Name + type: STRING + deprecated: false + required: true + string_validators: + regexp: '' + description: Enter the Segment Property Name. + settings: [] - name: fieldName display_name: Responsys Column Name type: STRING @@ -16685,15 +16746,6 @@ items: required: false description: Mark this property as a Primary Key in Responsys. settings: [] - - name: columns - display_name: Segment Property Name - type: STRING - deprecated: false - required: true - string_validators: - regexp: '' - description: Enter the Segment Property Name. - settings: [] - name: mapEmail display_name: Map Email type: BOOLEAN diff --git a/src/_data/catalog/source_categories.yml b/src/_data/catalog/source_categories.yml index 8430531f74..985bf1b0b2 100644 --- a/src/_data/catalog/source_categories.yml +++ b/src/_data/catalog/source_categories.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT -# source cateogries last updated 2020-07-09 +# source cateogries last updated 2020-07-13 items: - display_name: Server slug: server diff --git a/src/_data/catalog/sources.yml b/src/_data/catalog/sources.yml index 586764d187..d3ff896e1b 100644 --- a/src/_data/catalog/sources.yml +++ b/src/_data/catalog/sources.yml @@ -1,5 +1,5 @@ # AUTOGENERATED FROM PLATFORM API. DO NOT EDIT -# sources last updated 2020-07-09 +# sources last updated 2020-07-13 items: - display_name: .NET slug: net diff --git a/src/connections/destinations/catalog/calixa/index.md b/src/connections/destinations/catalog/calixa/index.md new file mode 100644 index 0000000000..69dec78e11 --- /dev/null +++ b/src/connections/destinations/catalog/calixa/index.md @@ -0,0 +1,68 @@ +--- +title: Calixa Destination +rewrite: true +--- + +[Calixa](https://www.calixa.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) makes it easy to manage all your customers in one place. No more jumping around tools, learning SQL, or maintaining internal tools. Calixa connects to the 3rd party SaaS tools you use (e.g. Stripe, Zendesk, Intercom, etc) so that you can see everything about your customers and take action in one place. + +This destination is maintained by Calixa. For any issues with the destination, [contact their support team](mailto:team@calixa.io). + +## Getting Started + +{% include content/connection-modes.md %} + +1. Login to your [Calixa account](https://console.calixa.io/login). +2. Go to the [Integrations page](https://console.calixa.io/integrations) and click "Add Integration". +3. Select the Segment Integration and sign in to your Segment account to grant Calixa access. + +## Track +If you aren't familiar with the Segment Spec, take a look at the [Track method documentation](https://segment.com/docs/connections/spec/track/) to learn about what it does. An example call would look like: + +```json +{ + 'userId': '019mr8mf4r', + 'action': 'track', + 'event': 'Account Created', + 'properties': { + 'account_name': 'Initech' + }, + 'context': { + 'groupId': 'acct_123' + } +} +``` + +Calixa supports the following Track calls from Segment's [B2B Spec](https://segment.com/docs/connections/spec/b2b-saas/): + +* [Signed Up](https://segment.com/docs/connections/spec/b2b-saas/#signed-up) - Creates a user in Calixa +* [Account Created](https://segment.com/docs/connections/spec/b2b-saas/#account-created) - Creates an account in Calixa +* [Account Deleted](https://segment.com/docs/connections/spec/b2b-saas/#account-deleted) - Deletes an account in Calixa +* [Account Added User](https://segment.com/docs/connections/spec/b2b-saas/#account-added-user) - Adds a user to an account +* [Account Removed User](https://segment.com/docs/connections/spec/b2b-saas/#account-removed-user) - Removes a user from an account + +## Identify +If you aren't familiar with the Segment Spec, take a look at the [Identify method documentation](https://segment.com/docs/connections/spec/identify/) to learn about what it does. An example call would look like: + +```js +analytics.identify('userId123', { + email: 'john.doe@example.com' +}); +``` +Segment sends Identify calls to Calixa as an `identify` event. When you identify a new user, the User is created in Calixa. If the User already exists, the User's properties are updated. + +## Group +If you aren't familiar with the Segment Spec, take a look at the [Group method documentation](https://segment.com/docs/connections/spec/group/) to learn about what it does. An example call would look like: +```json +{ + 'type': 'group', + 'groupId': '0e8c78ea9d97a7b8185e8632', + 'traits': { + 'name': 'Initech', + 'industry': 'Technology', + 'employees': 329, + 'plan': 'enterprise', + 'total billed': 830 + } +} +``` +Segment sends Group calls to Calixa as an `group` event. A `group` event can create an Account or associate a User to an Account within Calixa. From 37c40224fa3a9553484181b9e77e93718edc30f1 Mon Sep 17 00:00:00 2001 From: pauljaeinyoo Date: Tue, 14 Jul 2020 14:10:52 -0600 Subject: [PATCH 2/5] Update src/connections/destinations/catalog/calixa/index.md Co-authored-by: LRubin --- src/connections/destinations/catalog/calixa/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/calixa/index.md b/src/connections/destinations/catalog/calixa/index.md index 69dec78e11..5c09f03b0b 100644 --- a/src/connections/destinations/catalog/calixa/index.md +++ b/src/connections/destinations/catalog/calixa/index.md @@ -3,7 +3,7 @@ title: Calixa Destination rewrite: true --- -[Calixa](https://www.calixa.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) makes it easy to manage all your customers in one place. No more jumping around tools, learning SQL, or maintaining internal tools. Calixa connects to the 3rd party SaaS tools you use (e.g. Stripe, Zendesk, Intercom, etc) so that you can see everything about your customers and take action in one place. +[Calixa](https://www.calixa.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) makes it easy to manage all your customers in one place. No more jumping around from tool to tool, learning SQL, or maintaining internal tools. Calixa connects to the third party SaaS tools you use (like Stripe, Zendesk, and Intercom) so that you can see everything about your customers and take action in one place. This destination is maintained by Calixa. For any issues with the destination, [contact their support team](mailto:team@calixa.io). From d9f8f5a384fd45a19450617e47e2d939c6575d87 Mon Sep 17 00:00:00 2001 From: pauljaeinyoo Date: Tue, 14 Jul 2020 14:11:02 -0600 Subject: [PATCH 3/5] Update src/connections/destinations/catalog/calixa/index.md Co-authored-by: LRubin --- src/connections/destinations/catalog/calixa/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/calixa/index.md b/src/connections/destinations/catalog/calixa/index.md index 5c09f03b0b..c1604b314f 100644 --- a/src/connections/destinations/catalog/calixa/index.md +++ b/src/connections/destinations/catalog/calixa/index.md @@ -5,7 +5,7 @@ rewrite: true [Calixa](https://www.calixa.io/?utm_source=segmentio&utm_medium=docs&utm_campaign=partners) makes it easy to manage all your customers in one place. No more jumping around from tool to tool, learning SQL, or maintaining internal tools. Calixa connects to the third party SaaS tools you use (like Stripe, Zendesk, and Intercom) so that you can see everything about your customers and take action in one place. -This destination is maintained by Calixa. For any issues with the destination, [contact their support team](mailto:team@calixa.io). +This destination is maintained by Calixa. For any issues with the destination, [contact the Calixa support team](mailto:team@calixa.io). ## Getting Started From 14b327c05f64d9cf778c63350c712ea9a85893e8 Mon Sep 17 00:00:00 2001 From: pauljaeinyoo Date: Tue, 14 Jul 2020 14:11:13 -0600 Subject: [PATCH 4/5] Update src/connections/destinations/catalog/calixa/index.md Co-authored-by: LRubin --- src/connections/destinations/catalog/calixa/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/calixa/index.md b/src/connections/destinations/catalog/calixa/index.md index c1604b314f..06d48c9190 100644 --- a/src/connections/destinations/catalog/calixa/index.md +++ b/src/connections/destinations/catalog/calixa/index.md @@ -12,7 +12,7 @@ This destination is maintained by Calixa. For any issues with the destination, [ {% include content/connection-modes.md %} 1. Login to your [Calixa account](https://console.calixa.io/login). -2. Go to the [Integrations page](https://console.calixa.io/integrations) and click "Add Integration". +2. Go to the [Integrations page](https://console.calixa.io/integrations) and click **Add Integration**. 3. Select the Segment Integration and sign in to your Segment account to grant Calixa access. ## Track From 1540e390a81dda7fa0578582fd1b9a6d2e7be178 Mon Sep 17 00:00:00 2001 From: pauljaeinyoo Date: Tue, 14 Jul 2020 14:11:38 -0600 Subject: [PATCH 5/5] Update src/connections/destinations/catalog/calixa/index.md Co-authored-by: LRubin --- src/connections/destinations/catalog/calixa/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/calixa/index.md b/src/connections/destinations/catalog/calixa/index.md index 06d48c9190..279feec92f 100644 --- a/src/connections/destinations/catalog/calixa/index.md +++ b/src/connections/destinations/catalog/calixa/index.md @@ -48,7 +48,7 @@ analytics.identify('userId123', { email: 'john.doe@example.com' }); ``` -Segment sends Identify calls to Calixa as an `identify` event. When you identify a new user, the User is created in Calixa. If the User already exists, the User's properties are updated. +Segment sends Identify calls to Calixa as an `identify` event. When you identify a new user, Calixa creates a new User record. If the User already exists, Calixa updates the User's properties. ## Group If you aren't familiar with the Segment Spec, take a look at the [Group method documentation](https://segment.com/docs/connections/spec/group/) to learn about what it does. An example call would look like: