From 6888604a4ebe7ba6843ae3c49c6cb99126a2a1e3 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Tue, 1 Mar 2022 16:03:51 -0500 Subject: [PATCH 01/51] Basic first draft of BCR compliance docs --- src/privacy/bcr-compliance.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 src/privacy/bcr-compliance.md diff --git a/src/privacy/bcr-compliance.md b/src/privacy/bcr-compliance.md new file mode 100644 index 0000000000..776868e39d --- /dev/null +++ b/src/privacy/bcr-compliance.md @@ -0,0 +1,21 @@ +--- +title: Complying with Twilio's Binding Corporate Rules (BCRs) +--- + +In response to the passage of the General Data Protection Regulation (GDPR) policy in the European Union, Twilio implemented a set of [Binding Corporate Rules (BCRs)](https://www.twilio.com/legal/binding-corporate-rules) that inform how Twilio, Segment, and Sendgrid store and process personal data. + +## What are Binding Corporate Rules? + +### Where can I learn more about Twilio's Binding Corporate Rules? + +### How can I delete data from my workspace? + +To delete all data from your workspace, including customer data: + +1. Open the Segment app, and select **Settings.** +2. On the General Settings page, click the **Delete Workspace** button. +3. Follow the prompts on the pop-up to delete your workspace. + +After you delete your workspace, Segment will purge all data from internal servers after XYZ days. + +### What is a data purge? From afb5c201da7e94683ef1d58058f45c352506bc5e Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Thu, 3 Mar 2022 16:05:04 -0500 Subject: [PATCH 02/51] DOC-460 Content updates --- src/privacy/bcr-compliance.md | 32 ++++++++++++++++++++++++++++---- 1 file changed, 28 insertions(+), 4 deletions(-) diff --git a/src/privacy/bcr-compliance.md b/src/privacy/bcr-compliance.md index 776868e39d..30304495c4 100644 --- a/src/privacy/bcr-compliance.md +++ b/src/privacy/bcr-compliance.md @@ -2,13 +2,23 @@ title: Complying with Twilio's Binding Corporate Rules (BCRs) --- -In response to the passage of the General Data Protection Regulation (GDPR) policy in the European Union, Twilio implemented a set of [Binding Corporate Rules (BCRs)](https://www.twilio.com/legal/binding-corporate-rules) that inform how Twilio, Segment, and Sendgrid store and process personal data. + ## What are Binding Corporate Rules? +[Binding Corporate Rules (BCRs)](https://ec.europa.eu/info/law/law-topic/data-protection/international-dimension-data-protection/binding-corporate-rules-bcr_en) are enforceable, legally binding codes of conduct that explain the ways companies store and process personal data. BCRs must be approved by the data protection authority in all European Union member states, as stipulated in [Article 63 of the GDPR](https://eur-lex.europa.eu/legal-content/EN/TXT/PDF/?uri=CELEX:32016R0679&from=EN). + ### Where can I learn more about Twilio's Binding Corporate Rules? + +You can learn more about Twilio's Binding Corporate Rules (BCRs) by navigating to the [web version of the BCRs](https://www.twilio.com/legal/bcr) or by reaching out to + + + +## What do the Binding Corporate Rules mean for my data? -### How can I delete data from my workspace? + + +## How can I delete data from my workspace? To delete all data from your workspace, including customer data: @@ -16,6 +26,20 @@ To delete all data from your workspace, including customer data: 2. On the General Settings page, click the **Delete Workspace** button. 3. Follow the prompts on the pop-up to delete your workspace. -After you delete your workspace, Segment will purge all data from internal servers after XYZ days. +After you delete your workspace, Segment removes all data associated with your workspace and users immediately in a process called a [complete data purge](#what-is-a-complete-data-purge). + +If you do not manually delete your data after you stop using Segment, it is removed from Segment servers after 30 days. + + + +> warning " " +> If you deleted your workspace prior to March 31, 2022, and would like to have data associated with your workspace purged from Segment servers, please reach out to the Deletions and Compliance team [friends@segment.com](mailto:friends@segment.com) with the slug, workplace owner, and nickname of the workspace you would like to have purged from Segment servers. + + + +### What is a complete data purge? -### What is a data purge? +A complete data purge is the mechanism Segment uses to completely remove all workspace and customer data from internal Segment servers. To trigger a complete data purge, either [delete your workspace](#how-can-i-delete-data-from-my-workspace) or provide a written request to the Deletions and Compliance team [friends@segment.com](mailto:friends@segment.com) that contains the following information: +- slug +- workplace owner +- nickname of the workspace From 2d34465df6cb0f3f09941c5e22852dc16bca0015 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Thu, 3 Mar 2022 16:06:09 -0500 Subject: [PATCH 03/51] DOC-360 Forgot to save --- src/privacy/bcr-compliance.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/privacy/bcr-compliance.md b/src/privacy/bcr-compliance.md index 30304495c4..ac514c6b77 100644 --- a/src/privacy/bcr-compliance.md +++ b/src/privacy/bcr-compliance.md @@ -2,6 +2,7 @@ title: Complying with Twilio's Binding Corporate Rules (BCRs) --- +In response to the passage of the General Data Protection Regulation (GDPR) policy in the European Union, Twilio implemented a set of [Binding Corporate Rules (BCRs)](https://www.twilio.com/legal/binding-corporate-rules) that inform how Twilio, Segment, and Sendgrid store and process personal data. In order to be in alignment with Twilio's BCRs, Segment introduced a new data deletion process that allow customers to remove all of their workspace and user data immediately. ## What are Binding Corporate Rules? From 3842fb6e478b25f2a8a67a4fd65993e401ab8bd0 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Fri, 4 Mar 2022 16:03:07 -0500 Subject: [PATCH 04/51] DOC-460 Updating BCR page with info from meeting with PM --- src/_data/sidenav/main.yml | 2 + src/privacy/bcr-compliance.md | 47 +++++++++++--------- src/privacy/user-deletion-and-suppression.md | 2 +- 3 files changed, 30 insertions(+), 21 deletions(-) diff --git a/src/_data/sidenav/main.yml b/src/_data/sidenav/main.yml index b4fd3df6e4..f9a42e0602 100644 --- a/src/_data/sidenav/main.yml +++ b/src/_data/sidenav/main.yml @@ -322,6 +322,8 @@ sections: title: Complying With GDPR - path: /privacy/user-deletion-and-suppression title: User Deletion and Suppression + - path: /privacy/bcr-compliance + title: Twilio's Binding Corporate Rules - path: /privacy/faq title: Privacy FAQs - section_title: Protocols diff --git a/src/privacy/bcr-compliance.md b/src/privacy/bcr-compliance.md index ac514c6b77..21d2002bc5 100644 --- a/src/privacy/bcr-compliance.md +++ b/src/privacy/bcr-compliance.md @@ -1,46 +1,53 @@ --- -title: Complying with Twilio's Binding Corporate Rules (BCRs) +title: Twilio's Binding Corporate Rules (BCRs) --- -In response to the passage of the General Data Protection Regulation (GDPR) policy in the European Union, Twilio implemented a set of [Binding Corporate Rules (BCRs)](https://www.twilio.com/legal/binding-corporate-rules) that inform how Twilio, Segment, and Sendgrid store and process personal data. In order to be in alignment with Twilio's BCRs, Segment introduced a new data deletion process that allow customers to remove all of their workspace and user data immediately. - +In response to the passage of the General Data Protection Regulation (GDPR) policy in the European Union, Twilio implemented a set of [Binding Corporate Rules (BCRs)](https://www.twilio.com/legal/binding-corporate-rules) that inform how Segment stores and processes personal data. In order to be in alignment with Twilio's BCRs, Segment introduced a new data deletion process that allows customers to remove all of their workspace and user data within 30 days of deleting their workspace. ## What are Binding Corporate Rules? -[Binding Corporate Rules (BCRs)](https://ec.europa.eu/info/law/law-topic/data-protection/international-dimension-data-protection/binding-corporate-rules-bcr_en) are enforceable, legally binding codes of conduct that explain the ways companies store and process personal data. BCRs must be approved by the data protection authority in all European Union member states, as stipulated in [Article 63 of the GDPR](https://eur-lex.europa.eu/legal-content/EN/TXT/PDF/?uri=CELEX:32016R0679&from=EN). +[Binding Corporate Rules (BCRs)](https://ec.europa.eu/info/law/law-topic/data-protection/international-dimension-data-protection/binding-corporate-rules-bcr_en) are enforceable, legally binding codes of conduct that explain the ways companies store and process personal data. These codes contain information about data protection principles, tools used to protect the security of your data, and a method of accountability, or some way that proves the BCRs are externally (outside of the company) and internally (inside of the company) binding. BCRs are often specific to the storage and transfer (Controller) or processing (Processor) of personal data. + +Twilio has two sets of BCRs: a [Controller policy](https://www.twilio.com/legal/bcr/controller) and a [Processor policy](https://www.twilio.com/legal/bcr/processor). Segment, as a processor of individual data, falls under the Processor policy. ### Where can I learn more about Twilio's Binding Corporate Rules? -You can learn more about Twilio's Binding Corporate Rules (BCRs) by navigating to the [web version of the BCRs](https://www.twilio.com/legal/bcr) or by reaching out to +You can learn more about Twilio's Binding Corporate Rules (BCRs) by reading the [latest version of the BCRs](https://www.twilio.com/legal/bcr) or by reaching out to privacy@twilio.com. - +### What do Twilio's Binding Corporate Rules mean for my data? -## What do the Binding Corporate Rules mean for my data? + - +Twilio's BCRs ## How can I delete data from my workspace? +You can choose to delete the data from an individual user, from an entire source, or from your entire workspace. + +### Deleting individual user data +To delete the data for an individual user from you workspace, follow the instructions on the [User Deletion and Suppression](/docs/privacy/user-deletion-and-suppression) page. + +### Deleting data from a source +To delete the data for an entire source, send a request to the the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com) with your workplace slug, the source you'd like to delete data from, and the time frame for the data you'd like to delete. + +> note "Deleting source data" +> When Segment deletes your data for a particular source, they do not forward that deletion to sources or data storage providers associated with your account. To remove your data from external providers, please reach out to the individual providers about their deletion practices. + +### Deleting your workspace data + To delete all data from your workspace, including customer data: 1. Open the Segment app, and select **Settings.** 2. On the General Settings page, click the **Delete Workspace** button. 3. Follow the prompts on the pop-up to delete your workspace. -After you delete your workspace, Segment removes all data associated with your workspace and users immediately in a process called a [complete data purge](#what-is-a-complete-data-purge). - -If you do not manually delete your data after you stop using Segment, it is removed from Segment servers after 30 days. - - +After you delete your workspace, Segment removes all data associated with your workspace within 30 days in a process called a [complete data purge](#what-is-a-complete-data-purge). -> warning " " -> If you deleted your workspace prior to March 31, 2022, and would like to have data associated with your workspace purged from Segment servers, please reach out to the Deletions and Compliance team [friends@segment.com](mailto:friends@segment.com) with the slug, workplace owner, and nickname of the workspace you would like to have purged from Segment servers. +> warning "Purging data from workspaces deleted prior to March 31, 2022" +> If you deleted your workspace prior to March 31, 2022, and would like to have data associated with your workspace purged from Segment servers, please raise a support ticket with the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com). In your email to Customer Success, please include either the slug or the ID of the workspace you'd like to have purged from Segment servers. - +If you do not delete your data after you stop using Segment, it remains in Segment's internal servers until you submit a written request that your data be deleted. ### What is a complete data purge? -A complete data purge is the mechanism Segment uses to completely remove all workspace and customer data from internal Segment servers. To trigger a complete data purge, either [delete your workspace](#how-can-i-delete-data-from-my-workspace) or provide a written request to the Deletions and Compliance team [friends@segment.com](mailto:friends@segment.com) that contains the following information: -- slug -- workplace owner -- nickname of the workspace +A complete data purge is the mechanism Segment uses to completely remove all workspace and customer data from internal Segment servers. To trigger a complete data purge, either [delete your workspace](#how-can-i-delete-data-from-my-workspace) or raise a support ticket with the Customer Success team [friends@segment.com](mailto:friends@segment.com) that contains either the workplace slug or the workspace ID of the workspace that you'd like to delete. diff --git a/src/privacy/user-deletion-and-suppression.md b/src/privacy/user-deletion-and-suppression.md index 2a3f8a3b58..a040560f63 100644 --- a/src/privacy/user-deletion-and-suppression.md +++ b/src/privacy/user-deletion-and-suppression.md @@ -6,7 +6,7 @@ In keeping with Segment's commitment to GDPR and CCPA readiness, Segment offers [Contact Support](https://segment.com/help/contact/) if you need to process more than 100,000 users within a 30 day period. -> info "Business Plan Customers)" +> info "Business Plan Customers" > If you use this feature to delete data, you can not Replay the deleted data. For standard Replay requests, you must wait for any pending deletions to complete, and you cannot submit new deletion requests for the period of time that Segment replays data for you. > info "" From cf6648dc2ce70060739f901b5ad3e72c542b4f6e Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Fri, 4 Mar 2022 16:06:39 -0500 Subject: [PATCH 05/51] DOC-460 added status update note, removed weasel words --- src/privacy/bcr-compliance.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/privacy/bcr-compliance.md b/src/privacy/bcr-compliance.md index 21d2002bc5..e3c3c96e85 100644 --- a/src/privacy/bcr-compliance.md +++ b/src/privacy/bcr-compliance.md @@ -31,7 +31,7 @@ To delete the data for an individual user from you workspace, follow the instruc To delete the data for an entire source, send a request to the the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com) with your workplace slug, the source you'd like to delete data from, and the time frame for the data you'd like to delete. > note "Deleting source data" -> When Segment deletes your data for a particular source, they do not forward that deletion to sources or data storage providers associated with your account. To remove your data from external providers, please reach out to the individual providers about their deletion practices. +> When Segment deletes your data for a particular source, they do not forward that deletion to sources or data storage providers associated with your account. To remove your data from external providers, reach out to the individual providers about their deletion practices. ### Deleting your workspace data @@ -41,10 +41,10 @@ To delete all data from your workspace, including customer data: 2. On the General Settings page, click the **Delete Workspace** button. 3. Follow the prompts on the pop-up to delete your workspace. -After you delete your workspace, Segment removes all data associated with your workspace within 30 days in a process called a [complete data purge](#what-is-a-complete-data-purge). +After you delete your workspace, Segment removes all data associated with your workspace within 30 days in a process called a [complete data purge](#what-is-a-complete-data-purge). For a status update on the deletion progress, raise a support ticket with the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com). > warning "Purging data from workspaces deleted prior to March 31, 2022" -> If you deleted your workspace prior to March 31, 2022, and would like to have data associated with your workspace purged from Segment servers, please raise a support ticket with the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com). In your email to Customer Success, please include either the slug or the ID of the workspace you'd like to have purged from Segment servers. +> If you deleted your workspace prior to March 31, 2022, and would like to have data associated with your workspace purged from Segment servers, raise a support ticket with the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com). In your email to Customer Success, include either the slug or the ID of the workspace you'd like to have purged from Segment servers. If you do not delete your data after you stop using Segment, it remains in Segment's internal servers until you submit a written request that your data be deleted. From 1c2afeef732e3d0848069d36082e1e6a0eb508f8 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Mon, 7 Mar 2022 11:24:36 -0500 Subject: [PATCH 06/51] DOC-460 updating an answer, minor grammar edits --- src/privacy/bcr-compliance.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/src/privacy/bcr-compliance.md b/src/privacy/bcr-compliance.md index e3c3c96e85..ed58b12f3a 100644 --- a/src/privacy/bcr-compliance.md +++ b/src/privacy/bcr-compliance.md @@ -2,13 +2,13 @@ title: Twilio's Binding Corporate Rules (BCRs) --- -In response to the passage of the General Data Protection Regulation (GDPR) policy in the European Union, Twilio implemented a set of [Binding Corporate Rules (BCRs)](https://www.twilio.com/legal/binding-corporate-rules) that inform how Segment stores and processes personal data. In order to be in alignment with Twilio's BCRs, Segment introduced a new data deletion process that allows customers to remove all of their workspace and user data within 30 days of deleting their workspace. +In response to the passage of the General Data Protection Regulation (GDPR) policy in the European Union, Twilio implemented a set of [Binding Corporate Rules (BCRs)](https://www.twilio.com/legal/binding-corporate-rules) that inform how Segment stores and processes personal data. To be in alignment with Twilio's BCRs, Segment introduced a new data deletion process that allows customers to remove all of their workspace data within 30 days of deleting their workspace. ## What are Binding Corporate Rules? [Binding Corporate Rules (BCRs)](https://ec.europa.eu/info/law/law-topic/data-protection/international-dimension-data-protection/binding-corporate-rules-bcr_en) are enforceable, legally binding codes of conduct that explain the ways companies store and process personal data. These codes contain information about data protection principles, tools used to protect the security of your data, and a method of accountability, or some way that proves the BCRs are externally (outside of the company) and internally (inside of the company) binding. BCRs are often specific to the storage and transfer (Controller) or processing (Processor) of personal data. -Twilio has two sets of BCRs: a [Controller policy](https://www.twilio.com/legal/bcr/controller) and a [Processor policy](https://www.twilio.com/legal/bcr/processor). Segment, as a processor of individual data, falls under the Processor policy. +Twilio has two sets of BCRs: a [Controller policy](https://www.twilio.com/legal/bcr/controller) and a [Processor policy](https://www.twilio.com/legal/bcr/processor). Segment, as a processor of individual data, complies with the Processor policy. ### Where can I learn more about Twilio's Binding Corporate Rules? @@ -16,9 +16,7 @@ You can learn more about Twilio's Binding Corporate Rules (BCRs) by reading the ### What do Twilio's Binding Corporate Rules mean for my data? - - -Twilio's BCRs +Twilio's BCRs inform the way your user data must be stored and processed. While the ways Segment processes and stores user data are already in compliance with Twilio BCRs, [additional data deletion methods](#how-can-i-delete-data-from-my-workspace) were added to comply with the ["Storage limitation"](https://www.twilio.com/legal/bcr/processor#part-ii-our-obligations) section of the Processor policy. These new data deletion methods allow you to delete the data associated with [individual users](#deleting-individual-user-data), [sources](#deleting-data-from-a-source), and your [workspace](#deleting-your-workspace-data). ## How can I delete data from my workspace? @@ -31,7 +29,7 @@ To delete the data for an individual user from you workspace, follow the instruc To delete the data for an entire source, send a request to the the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com) with your workplace slug, the source you'd like to delete data from, and the time frame for the data you'd like to delete. > note "Deleting source data" -> When Segment deletes your data for a particular source, they do not forward that deletion to sources or data storage providers associated with your account. To remove your data from external providers, reach out to the individual providers about their deletion practices. +> When Segment deletes your data for a particular source, the deletion is not forwarded to sources or data storage providers associated with your account. To remove your data from external sources, reach out to the individual source about their deletion practices. ### Deleting your workspace data @@ -41,7 +39,7 @@ To delete all data from your workspace, including customer data: 2. On the General Settings page, click the **Delete Workspace** button. 3. Follow the prompts on the pop-up to delete your workspace. -After you delete your workspace, Segment removes all data associated with your workspace within 30 days in a process called a [complete data purge](#what-is-a-complete-data-purge). For a status update on the deletion progress, raise a support ticket with the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com). +After you delete your workspace, Segment removes all data associated with your workspace within 30 days in a process called a [complete data purge](#what-is-a-complete-data-purge). For a data purge status update, create a support ticket with the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com). > warning "Purging data from workspaces deleted prior to March 31, 2022" > If you deleted your workspace prior to March 31, 2022, and would like to have data associated with your workspace purged from Segment servers, raise a support ticket with the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com). In your email to Customer Success, include either the slug or the ID of the workspace you'd like to have purged from Segment servers. From 01c30116d9d0ede7585d72e66f816e04f672ffed Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Mon, 7 Mar 2022 15:34:29 -0500 Subject: [PATCH 07/51] DOC-460 Editing pass --- src/privacy/bcr-compliance.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/privacy/bcr-compliance.md b/src/privacy/bcr-compliance.md index ed58b12f3a..706df4bdf1 100644 --- a/src/privacy/bcr-compliance.md +++ b/src/privacy/bcr-compliance.md @@ -8,15 +8,15 @@ In response to the passage of the General Data Protection Regulation (GDPR) poli [Binding Corporate Rules (BCRs)](https://ec.europa.eu/info/law/law-topic/data-protection/international-dimension-data-protection/binding-corporate-rules-bcr_en) are enforceable, legally binding codes of conduct that explain the ways companies store and process personal data. These codes contain information about data protection principles, tools used to protect the security of your data, and a method of accountability, or some way that proves the BCRs are externally (outside of the company) and internally (inside of the company) binding. BCRs are often specific to the storage and transfer (Controller) or processing (Processor) of personal data. -Twilio has two sets of BCRs: a [Controller policy](https://www.twilio.com/legal/bcr/controller) and a [Processor policy](https://www.twilio.com/legal/bcr/processor). Segment, as a processor of individual data, complies with the Processor policy. +Twilio has two BCR policies: a [Controller policy](https://www.twilio.com/legal/bcr/controller) and a [Processor policy](https://www.twilio.com/legal/bcr/processor). Segment, as a processor of individual data, complies with the Processor policy. ### Where can I learn more about Twilio's Binding Corporate Rules? -You can learn more about Twilio's Binding Corporate Rules (BCRs) by reading the [latest version of the BCRs](https://www.twilio.com/legal/bcr) or by reaching out to privacy@twilio.com. +You can learn more about Twilio's Binding Corporate Rules (BCRs) by reading the [full version on twilio.com/legal](https://www.twilio.com/legal/bcr) or by reaching out to [privacy@twilio.com](mailto:privacy@twilio.com). ### What do Twilio's Binding Corporate Rules mean for my data? -Twilio's BCRs inform the way your user data must be stored and processed. While the ways Segment processes and stores user data are already in compliance with Twilio BCRs, [additional data deletion methods](#how-can-i-delete-data-from-my-workspace) were added to comply with the ["Storage limitation"](https://www.twilio.com/legal/bcr/processor#part-ii-our-obligations) section of the Processor policy. These new data deletion methods allow you to delete the data associated with [individual users](#deleting-individual-user-data), [sources](#deleting-data-from-a-source), and your [workspace](#deleting-your-workspace-data). +Twilio's BCRs inform the way your user data must be stored, processed, and deleted. While the ways Segment processes and stores user data are already in compliance with Twilio BCRs, [additional data deletion methods](#how-can-i-delete-data-from-my-workspace) were added to comply with the ["Storage limitation"](https://www.twilio.com/legal/bcr/processor#part-ii-our-obligations) section of the Processor policy. These new data deletion methods allow you to delete the data associated with [individual users](#deleting-individual-user-data), [sources](#deleting-data-from-a-source), and your [workspace](#deleting-your-workspace-data). ## How can I delete data from my workspace? @@ -42,7 +42,7 @@ To delete all data from your workspace, including customer data: After you delete your workspace, Segment removes all data associated with your workspace within 30 days in a process called a [complete data purge](#what-is-a-complete-data-purge). For a data purge status update, create a support ticket with the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com). > warning "Purging data from workspaces deleted prior to March 31, 2022" -> If you deleted your workspace prior to March 31, 2022, and would like to have data associated with your workspace purged from Segment servers, raise a support ticket with the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com). In your email to Customer Success, include either the slug or the ID of the workspace you'd like to have purged from Segment servers. +> If you deleted your workspace prior to March 31, 2022, and would like to have data associated with your workspace purged from Segment servers, raise a support ticket with the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com). In your email to Customer Success, include either the slug or the ID of the workspace you'd like to have purged from internal Segment servers. If you do not delete your data after you stop using Segment, it remains in Segment's internal servers until you submit a written request that your data be deleted. From 9b592c05ac397722777a73734f806002cc8fd02a Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Mon, 7 Mar 2022 16:04:57 -0500 Subject: [PATCH 08/51] DOC-460 More edits --- src/privacy/bcr-compliance.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/src/privacy/bcr-compliance.md b/src/privacy/bcr-compliance.md index 706df4bdf1..2a6188a8d8 100644 --- a/src/privacy/bcr-compliance.md +++ b/src/privacy/bcr-compliance.md @@ -2,36 +2,36 @@ title: Twilio's Binding Corporate Rules (BCRs) --- -In response to the passage of the General Data Protection Regulation (GDPR) policy in the European Union, Twilio implemented a set of [Binding Corporate Rules (BCRs)](https://www.twilio.com/legal/binding-corporate-rules) that inform how Segment stores and processes personal data. To be in alignment with Twilio's BCRs, Segment introduced a new data deletion process that allows customers to remove all of their workspace data within 30 days of deleting their workspace. +In response to the passage of the General Data Protection Regulation (GDPR) policy in the European Union, Twilio implemented a set of [Binding Corporate Rules (BCRs)](https://www.twilio.com/legal/binding-corporate-rules) that inform how Segment stores, processes, and deletes personal data. To be in alignment with Twilio's BCRs, Segment introduced a new data deletion process that allows customers to remove all of their workspace data within 30 days of deleting their workspace. ## What are Binding Corporate Rules? -[Binding Corporate Rules (BCRs)](https://ec.europa.eu/info/law/law-topic/data-protection/international-dimension-data-protection/binding-corporate-rules-bcr_en) are enforceable, legally binding codes of conduct that explain the ways companies store and process personal data. These codes contain information about data protection principles, tools used to protect the security of your data, and a method of accountability, or some way that proves the BCRs are externally (outside of the company) and internally (inside of the company) binding. BCRs are often specific to the storage and transfer (Controller) or processing (Processor) of personal data. +[Binding Corporate Rules (BCRs)](https://ec.europa.eu/info/law/law-topic/data-protection/international-dimension-data-protection/binding-corporate-rules-bcr_en) are enforceable, legally binding codes of conduct that explain the ways companies store, process, and delete personal data. These codes contain information about data protection principles, tools used to protect the security of your data, and a method of accountability, or some way that proves the BCRs are externally (outside of the company) and internally (inside of the company) binding. BCRs are often specific to the storage and transfer (Controller) or processing (Processor) of personal data. Twilio has two BCR policies: a [Controller policy](https://www.twilio.com/legal/bcr/controller) and a [Processor policy](https://www.twilio.com/legal/bcr/processor). Segment, as a processor of individual data, complies with the Processor policy. ### Where can I learn more about Twilio's Binding Corporate Rules? -You can learn more about Twilio's Binding Corporate Rules (BCRs) by reading the [full version on twilio.com/legal](https://www.twilio.com/legal/bcr) or by reaching out to [privacy@twilio.com](mailto:privacy@twilio.com). +To learn more about Twilio's Binding Corporate Rules (BCRs,) read the [full version on twilio.com/legal](https://www.twilio.com/legal/bcr) or reach out to [privacy@twilio.com](mailto:privacy@twilio.com). ### What do Twilio's Binding Corporate Rules mean for my data? -Twilio's BCRs inform the way your user data must be stored, processed, and deleted. While the ways Segment processes and stores user data are already in compliance with Twilio BCRs, [additional data deletion methods](#how-can-i-delete-data-from-my-workspace) were added to comply with the ["Storage limitation"](https://www.twilio.com/legal/bcr/processor#part-ii-our-obligations) section of the Processor policy. These new data deletion methods allow you to delete the data associated with [individual users](#deleting-individual-user-data), [sources](#deleting-data-from-a-source), and your [workspace](#deleting-your-workspace-data). +Twilio's BCRs inform the way your user data must be stored, processed, and deleted. While the ways Segment stores and processes user data are already in compliance with Twilio's BCRs, [additional data deletion methods](#how-can-i-delete-data-from-my-workspace) were added to comply with the ["Storage limitation"](https://www.twilio.com/legal/bcr/processor#part-ii-our-obligations) section of the Processor policy. These data deletion methods now allow you to delete the data associated with [individual users](#delete-individual-user-data), [sources](#delete-data-from-a-source), and your [workspace](#delete-your-workspace-data). ## How can I delete data from my workspace? -You can choose to delete the data from an individual user, from an entire source, or from your entire workspace. +You can choose to delete the data from an individual user, an entire source, or your entire workspace. -### Deleting individual user data +### Delete individual user data To delete the data for an individual user from you workspace, follow the instructions on the [User Deletion and Suppression](/docs/privacy/user-deletion-and-suppression) page. -### Deleting data from a source -To delete the data for an entire source, send a request to the the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com) with your workplace slug, the source you'd like to delete data from, and the time frame for the data you'd like to delete. +### Delete data from a source +To delete the data for an entire source, email the Customer Success team [(friends@segment.com)](mailto:friends@segment.com) to create a support ticket. In your email to Customer Success, include your workplace slug, the source you'd like to delete data from, and the time frame for the data you'd like to delete. > note "Deleting source data" > When Segment deletes your data for a particular source, the deletion is not forwarded to sources or data storage providers associated with your account. To remove your data from external sources, reach out to the individual source about their deletion practices. -### Deleting your workspace data +### Delete your workspace data To delete all data from your workspace, including customer data: @@ -39,13 +39,13 @@ To delete all data from your workspace, including customer data: 2. On the General Settings page, click the **Delete Workspace** button. 3. Follow the prompts on the pop-up to delete your workspace. -After you delete your workspace, Segment removes all data associated with your workspace within 30 days in a process called a [complete data purge](#what-is-a-complete-data-purge). For a data purge status update, create a support ticket with the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com). +After you delete your workspace, Segment removes all data associated with your workspace within 30 days in a process called a [complete data purge](#what-is-a-complete-data-purge). For a data purge status update, email the Customer Success team [(friends@segment.com)](mailto:friends@segment.com) to create a support ticket. -> warning "Purging data from workspaces deleted prior to March 31, 2022" -> If you deleted your workspace prior to March 31, 2022, and would like to have data associated with your workspace purged from Segment servers, raise a support ticket with the Customer Success team by emailing [friends@segment.com](mailto:friends@segment.com). In your email to Customer Success, include either the slug or the ID of the workspace you'd like to have purged from internal Segment servers. +If you do not delete your workspace after you stop using Segment, **your data remains in Segment's internal servers until you submit a written deletion request**. -If you do not delete your data after you stop using Segment, it remains in Segment's internal servers until you submit a written request that your data be deleted. +> warning "Purging data from workspaces deleted prior to March 31, 2022" +> If you deleted your workspace prior to March 31, 2022, and would like to have data associated with your workspace purged from Segment servers, email the Customer Success team [friends@segment.com](mailto:friends@segment.com) to create a support ticket. In your email to Customer Success, include either the slug or the ID of the workspace you'd like to have purged from internal Segment servers. ### What is a complete data purge? -A complete data purge is the mechanism Segment uses to completely remove all workspace and customer data from internal Segment servers. To trigger a complete data purge, either [delete your workspace](#how-can-i-delete-data-from-my-workspace) or raise a support ticket with the Customer Success team [friends@segment.com](mailto:friends@segment.com) that contains either the workplace slug or the workspace ID of the workspace that you'd like to delete. +A complete data purge is the mechanism Segment uses to completely remove all workspace and customer data from internal Segment servers. To trigger a complete data purge, either [delete your workspace](#how-can-i-delete-data-from-my-workspace) or raise a support ticket with the Customer Success team [(friends@segment.com)](mailto:friends@segment.com) that contains either the slug or the ID of the workspace that you'd like to delete. From dc3696cc3c636d73e37e34882a3f05356e671283 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Mon, 7 Mar 2022 16:08:59 -0500 Subject: [PATCH 09/51] [netlify-build] --- src/privacy/bcr-compliance.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/privacy/bcr-compliance.md b/src/privacy/bcr-compliance.md index 2a6188a8d8..895ca3613c 100644 --- a/src/privacy/bcr-compliance.md +++ b/src/privacy/bcr-compliance.md @@ -49,3 +49,4 @@ If you do not delete your workspace after you stop using Segment, **your data re ### What is a complete data purge? A complete data purge is the mechanism Segment uses to completely remove all workspace and customer data from internal Segment servers. To trigger a complete data purge, either [delete your workspace](#how-can-i-delete-data-from-my-workspace) or raise a support ticket with the Customer Success team [(friends@segment.com)](mailto:friends@segment.com) that contains either the slug or the ID of the workspace that you'd like to delete. + From 5b419ac2ed0df44f4345ca9d52223bee61f5869c Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Tue, 8 Mar 2022 12:52:02 -0500 Subject: [PATCH 10/51] Apply suggestions from code review! Co-authored-by: pwseg <86626706+pwseg@users.noreply.github.com> --- src/privacy/bcr-compliance.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/privacy/bcr-compliance.md b/src/privacy/bcr-compliance.md index 895ca3613c..f821480da8 100644 --- a/src/privacy/bcr-compliance.md +++ b/src/privacy/bcr-compliance.md @@ -2,7 +2,7 @@ title: Twilio's Binding Corporate Rules (BCRs) --- -In response to the passage of the General Data Protection Regulation (GDPR) policy in the European Union, Twilio implemented a set of [Binding Corporate Rules (BCRs)](https://www.twilio.com/legal/binding-corporate-rules) that inform how Segment stores, processes, and deletes personal data. To be in alignment with Twilio's BCRs, Segment introduced a new data deletion process that allows customers to remove all of their workspace data within 30 days of deleting their workspace. +In response to the passage of the General Data Protection Regulation (GDPR) policy in the European Union, Twilio implemented a set of [Binding Corporate Rules (BCRs)](https://www.twilio.com/legal/binding-corporate-rules) that inform how Segment stores, processes, and deletes personal data. To align with Twilio's BCRs, Segment introduced a new data deletion process that allows customers to remove all of their workspace data within 30 days of deleting their workspace. ## What are Binding Corporate Rules? @@ -20,7 +20,7 @@ Twilio's BCRs inform the way your user data must be stored, processed, and delet ## How can I delete data from my workspace? -You can choose to delete the data from an individual user, an entire source, or your entire workspace. +You can delete data from an individual user, an entire source, or your entire workspace. ### Delete individual user data To delete the data for an individual user from you workspace, follow the instructions on the [User Deletion and Suppression](/docs/privacy/user-deletion-and-suppression) page. From ff502c76d2cb1c8ad1d2b680d20243ff7b0c6479 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 9 Mar 2022 12:14:32 -0500 Subject: [PATCH 11/51] Separating account deletion and BCR pages [netlify-build] --- src/_data/sidenav/main.yml | 4 ++- src/privacy/account-deletion.md | 50 +++++++++++++++++++++++++++++++++ src/privacy/bcr-compliance.md | 37 ++---------------------- 3 files changed, 55 insertions(+), 36 deletions(-) create mode 100644 src/privacy/account-deletion.md diff --git a/src/_data/sidenav/main.yml b/src/_data/sidenav/main.yml index f9a42e0602..c294843cb4 100644 --- a/src/_data/sidenav/main.yml +++ b/src/_data/sidenav/main.yml @@ -323,7 +323,9 @@ sections: - path: /privacy/user-deletion-and-suppression title: User Deletion and Suppression - path: /privacy/bcr-compliance - title: Twilio's Binding Corporate Rules + title: Twilio's Binding Corporate Rules + - path: /privacy/account-deletion + title: Account & Data Deletion - path: /privacy/faq title: Privacy FAQs - section_title: Protocols diff --git a/src/privacy/account-deletion.md b/src/privacy/account-deletion.md new file mode 100644 index 0000000000..f7bca20c6f --- /dev/null +++ b/src/privacy/account-deletion.md @@ -0,0 +1,50 @@ +--- +title: Account & Data Deletion +--- + +Segment allows you to delete data at a variety of levels. You can delete specific data relating to an individual end user, all data from associated with a source, or all data within your entire workspace. + +## Delete individual user data +To delete the data for an individual user from you workspace, follow the instructions on the [User Deletion and Suppression](/docs/privacy/user-deletion-and-suppression) page. + +## Delete data from a source +To delete the data for an entire source, email the Customer Success team [(friends@segment.com)](mailto:friends@segment.com) to create a support ticket. In your email to Customer Success, include the following information: +- Your workplace slug +- The source you'd like to delete data from +- The time frame for the data you'd like to delete* + +**Due to the way Segment stores data internally, source-level deletions can only be scoped to one day in granularity. Deletion requests for smaller time frames are not supported.* + +> note "Deleting source data" +> When Segment deletes your data for a particular source, the deletion is not forwarded to sources or data storage providers associated with your account: your data is only removed from Segment's S3 archive buckets. To remove your data from external sources, reach out to the individual source about their deletion practices. + +## Delete your workspace data + +Workspace admins can delete all of the data associated with a workspace, including customer data. + +To delete all data from one workspace: + +1. Open the Segment app, and select **Settings.** +2. On the General Settings page, click the **Delete Workspace** button. +3. Follow the prompts on the pop-up to delete your workspace. + +To delete data from all workspaces associated with your account: + +1. Sign in to the Segment app. +2. Navigate to the [User Settings page](https://app.segment.com/settings/user). +3. Click the **Delete Account** button, located at the bottom of the page. +4. On the popup, enter your password and select **Yep, delete my account anyway!** to delete your account. + +After you delete your workspace or account, Segment removes all data associated with each workspace within 30 days in a process called a [complete data purge](#what-is-a-complete-data-purge). For a data purge status update, email the Customer Success team [(friends@segment.com)](mailto:friends@segment.com). + +If you do not delete your workspace after you stop using Segment, **your data remains in Segment's internal servers until you submit a written deletion request**. + +> warning "Purging data from workspaces deleted prior to March 31, 2022" +> If you deleted your workspace prior to March 31, 2022, and would like to have data associated with your workspace purged from Segment servers, email the Customer Success team [friends@segment.com](mailto:friends@segment.com) to create a support ticket. In your email to Customer Success, include either the slug or the ID of the workspace you'd like to have purged from internal Segment servers. + +### What is a complete data purge? + +A complete data purge is the mechanism Segment uses to completely remove all workspace and customer data from internal Segment servers across all product areas. To trigger a complete data purge, either [delete your workspace](#how-can-i-delete-data-from-my-workspace) or raise a support ticket with the Customer Success team [(friends@segment.com)](mailto:friends@segment.com) that contains either the slug or the ID of the workspace that you'd like to delete. Data purge deletions will *not* be forwarded to your connected third-party destinations or raw destinations. + +> warning " " +> Segment waits for five days before beginning a complete data purge to safeguard against malicious deletion requests. If you notice your workspace or account has been maliciously deleted, reach out to [friends@segment.com](mailto:friends@segment.com) to cancel the data purge. After the five-day grace period, the deletion will be irreversible. \ No newline at end of file diff --git a/src/privacy/bcr-compliance.md b/src/privacy/bcr-compliance.md index f821480da8..7eafdb6e2d 100644 --- a/src/privacy/bcr-compliance.md +++ b/src/privacy/bcr-compliance.md @@ -2,7 +2,7 @@ title: Twilio's Binding Corporate Rules (BCRs) --- -In response to the passage of the General Data Protection Regulation (GDPR) policy in the European Union, Twilio implemented a set of [Binding Corporate Rules (BCRs)](https://www.twilio.com/legal/binding-corporate-rules) that inform how Segment stores, processes, and deletes personal data. To align with Twilio's BCRs, Segment introduced a new data deletion process that allows customers to remove all of their workspace data within 30 days of deleting their workspace. +In response to the passage of the General Data Protection Regulation (GDPR) policy in the European Union, Twilio implemented a set of [Binding Corporate Rules (BCRs)](https://www.twilio.com/legal/binding-corporate-rules) that inform how Segment stores, processes, and deletes personal data. To align with Twilio's BCRs, Segment introduced a new data deletion process that allows customers to remove all of their users' personal data associated with a workspace 30 days after either deleting their workspace or submitting a written deletion request. ## What are Binding Corporate Rules? @@ -16,37 +16,4 @@ To learn more about Twilio's Binding Corporate Rules (BCRs,) read the [full vers ### What do Twilio's Binding Corporate Rules mean for my data? -Twilio's BCRs inform the way your user data must be stored, processed, and deleted. While the ways Segment stores and processes user data are already in compliance with Twilio's BCRs, [additional data deletion methods](#how-can-i-delete-data-from-my-workspace) were added to comply with the ["Storage limitation"](https://www.twilio.com/legal/bcr/processor#part-ii-our-obligations) section of the Processor policy. These data deletion methods now allow you to delete the data associated with [individual users](#delete-individual-user-data), [sources](#delete-data-from-a-source), and your [workspace](#delete-your-workspace-data). - -## How can I delete data from my workspace? - -You can delete data from an individual user, an entire source, or your entire workspace. - -### Delete individual user data -To delete the data for an individual user from you workspace, follow the instructions on the [User Deletion and Suppression](/docs/privacy/user-deletion-and-suppression) page. - -### Delete data from a source -To delete the data for an entire source, email the Customer Success team [(friends@segment.com)](mailto:friends@segment.com) to create a support ticket. In your email to Customer Success, include your workplace slug, the source you'd like to delete data from, and the time frame for the data you'd like to delete. - -> note "Deleting source data" -> When Segment deletes your data for a particular source, the deletion is not forwarded to sources or data storage providers associated with your account. To remove your data from external sources, reach out to the individual source about their deletion practices. - -### Delete your workspace data - -To delete all data from your workspace, including customer data: - -1. Open the Segment app, and select **Settings.** -2. On the General Settings page, click the **Delete Workspace** button. -3. Follow the prompts on the pop-up to delete your workspace. - -After you delete your workspace, Segment removes all data associated with your workspace within 30 days in a process called a [complete data purge](#what-is-a-complete-data-purge). For a data purge status update, email the Customer Success team [(friends@segment.com)](mailto:friends@segment.com) to create a support ticket. - -If you do not delete your workspace after you stop using Segment, **your data remains in Segment's internal servers until you submit a written deletion request**. - -> warning "Purging data from workspaces deleted prior to March 31, 2022" -> If you deleted your workspace prior to March 31, 2022, and would like to have data associated with your workspace purged from Segment servers, email the Customer Success team [friends@segment.com](mailto:friends@segment.com) to create a support ticket. In your email to Customer Success, include either the slug or the ID of the workspace you'd like to have purged from internal Segment servers. - -### What is a complete data purge? - -A complete data purge is the mechanism Segment uses to completely remove all workspace and customer data from internal Segment servers. To trigger a complete data purge, either [delete your workspace](#how-can-i-delete-data-from-my-workspace) or raise a support ticket with the Customer Success team [(friends@segment.com)](mailto:friends@segment.com) that contains either the slug or the ID of the workspace that you'd like to delete. - +Twilio's BCRs inform the way your user data must be stored, processed, and deleted. While the ways Segment stores and processes user data are already in compliance with Twilio's BCRs, [an additional data deletion method](/docs/privacy/account-deletion/#delete-your-workspace-data) was introduced to comply with the ["Storage limitation"](https://www.twilio.com/legal/bcr/processor#part-ii-our-obligations) section of the Processor policy. This new data deletion method, along with the existing methods of deleting [individual user data](/docs/privacy/account-deletion/#delete-individual-user-data) and [source data](/docs/privacy/account-deletion/#delete-data-from-a-source), means that Segment is now in alignment with Twilio's BCRs. From 1969a05bb23e2ff99886ed61d2cfe43e051186f3 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 9 Mar 2022 15:19:36 -0500 Subject: [PATCH 12/51] DOC-460 Editing pass [netlify-build] --- src/privacy/account-deletion.md | 5 ++--- src/privacy/bcr-compliance.md | 2 +- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/src/privacy/account-deletion.md b/src/privacy/account-deletion.md index f7bca20c6f..fa22f92f8f 100644 --- a/src/privacy/account-deletion.md +++ b/src/privacy/account-deletion.md @@ -40,11 +40,10 @@ After you delete your workspace or account, Segment removes all data associated If you do not delete your workspace after you stop using Segment, **your data remains in Segment's internal servers until you submit a written deletion request**. > warning "Purging data from workspaces deleted prior to March 31, 2022" -> If you deleted your workspace prior to March 31, 2022, and would like to have data associated with your workspace purged from Segment servers, email the Customer Success team [friends@segment.com](mailto:friends@segment.com) to create a support ticket. In your email to Customer Success, include either the slug or the ID of the workspace you'd like to have purged from internal Segment servers. +> If you deleted your workspace prior to March 31, 2022, and would like to have data associated with your workspace purged from Segment's S3 archive buckets, email the Customer Success team [(friends@segment.com)](mailto:friends@segment.com) to create a support ticket. In your email to Customer Success, include either the slug or the ID of the workspace you'd like to have purged from internal Segment servers. ### What is a complete data purge? -A complete data purge is the mechanism Segment uses to completely remove all workspace and customer data from internal Segment servers across all product areas. To trigger a complete data purge, either [delete your workspace](#how-can-i-delete-data-from-my-workspace) or raise a support ticket with the Customer Success team [(friends@segment.com)](mailto:friends@segment.com) that contains either the slug or the ID of the workspace that you'd like to delete. Data purge deletions will *not* be forwarded to your connected third-party destinations or raw destinations. -> warning " " +> error " " > Segment waits for five days before beginning a complete data purge to safeguard against malicious deletion requests. If you notice your workspace or account has been maliciously deleted, reach out to [friends@segment.com](mailto:friends@segment.com) to cancel the data purge. After the five-day grace period, the deletion will be irreversible. \ No newline at end of file diff --git a/src/privacy/bcr-compliance.md b/src/privacy/bcr-compliance.md index 7eafdb6e2d..debfdd16d0 100644 --- a/src/privacy/bcr-compliance.md +++ b/src/privacy/bcr-compliance.md @@ -16,4 +16,4 @@ To learn more about Twilio's Binding Corporate Rules (BCRs,) read the [full vers ### What do Twilio's Binding Corporate Rules mean for my data? -Twilio's BCRs inform the way your user data must be stored, processed, and deleted. While the ways Segment stores and processes user data are already in compliance with Twilio's BCRs, [an additional data deletion method](/docs/privacy/account-deletion/#delete-your-workspace-data) was introduced to comply with the ["Storage limitation"](https://www.twilio.com/legal/bcr/processor#part-ii-our-obligations) section of the Processor policy. This new data deletion method, along with the existing methods of deleting [individual user data](/docs/privacy/account-deletion/#delete-individual-user-data) and [source data](/docs/privacy/account-deletion/#delete-data-from-a-source), means that Segment is now in alignment with Twilio's BCRs. +Twilio's BCRs inform the way your user data must be stored, processed, and deleted. While the ways Segment stores and processes user data are already in compliance with Twilio's BCRs, [an additional data deletion method](/docs/privacy/account-deletion/#delete-your-workspace-data) was introduced to comply with the ["Storage limitation"](https://www.twilio.com/legal/bcr/processor#part-ii-our-obligations) section of the Processor policy. This new data deletion method, along with the existing methods of deleting [individual user data](/docs/privacy/account-deletion/#delete-individual-user-data) and [source data](/docs/privacy/account-deletion/#delete-data-from-a-source), ensure that Segment's policies are now in alignment with Twilio's BCRs. From 63deeb687e0853a484c7929ffc5c7a26dfe49bfb Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 9 Mar 2022 15:20:10 -0500 Subject: [PATCH 13/51] [netlify-build] --- src/privacy/account-deletion.md | 1 + 1 file changed, 1 insertion(+) diff --git a/src/privacy/account-deletion.md b/src/privacy/account-deletion.md index fa22f92f8f..790976fcc5 100644 --- a/src/privacy/account-deletion.md +++ b/src/privacy/account-deletion.md @@ -44,6 +44,7 @@ If you do not delete your workspace after you stop using Segment, **your data re ### What is a complete data purge? +A complete data purge is the mechanism Segment uses to completely remove all workspace and customer data from internal Segment servers across all product areas. To trigger a complete data purge, either [delete your workspace](#how-can-i-delete-data-from-my-workspace) or raise a support ticket with the Customer Success team by emailing [(friends@segment.com)](mailto:friends@segment.com). In your email to Customer Success, include either the slug or the ID of the workspace that you'd like to delete. Deletions related to data purges will *not* be forwarded to your connected third-party destinations or raw data destinations. > error " " > Segment waits for five days before beginning a complete data purge to safeguard against malicious deletion requests. If you notice your workspace or account has been maliciously deleted, reach out to [friends@segment.com](mailto:friends@segment.com) to cancel the data purge. After the five-day grace period, the deletion will be irreversible. \ No newline at end of file From 086c295b8c37292c07f342ad4c74f2626bd2f159 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Thu, 10 Mar 2022 09:01:34 -0500 Subject: [PATCH 14/51] Editing pass [netlify-build] --- src/privacy/account-deletion.md | 12 ++++++------ src/privacy/bcr-compliance.md | 6 +++--- 2 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/privacy/account-deletion.md b/src/privacy/account-deletion.md index 790976fcc5..27642d232b 100644 --- a/src/privacy/account-deletion.md +++ b/src/privacy/account-deletion.md @@ -2,7 +2,7 @@ title: Account & Data Deletion --- -Segment allows you to delete data at a variety of levels. You can delete specific data relating to an individual end user, all data from associated with a source, or all data within your entire workspace. +Segment allows you to delete specific data relating to an individual end user, all data from associated with a source, or all data within your entire workspace. ## Delete individual user data To delete the data for an individual user from you workspace, follow the instructions on the [User Deletion and Suppression](/docs/privacy/user-deletion-and-suppression) page. @@ -22,13 +22,13 @@ To delete the data for an entire source, email the Customer Success team [(frien Workspace admins can delete all of the data associated with a workspace, including customer data. -To delete all data from one workspace: +**To delete all data from one workspace:** -1. Open the Segment app, and select **Settings.** +1. Sign in to the Segment app, select the workspace you'd like to delete, and click **Settings.** 2. On the General Settings page, click the **Delete Workspace** button. 3. Follow the prompts on the pop-up to delete your workspace. -To delete data from all workspaces associated with your account: +**To delete data from all workspaces in which you have workspace admin permissions:** 1. Sign in to the Segment app. 2. Navigate to the [User Settings page](https://app.segment.com/settings/user). @@ -44,7 +44,7 @@ If you do not delete your workspace after you stop using Segment, **your data re ### What is a complete data purge? -A complete data purge is the mechanism Segment uses to completely remove all workspace and customer data from internal Segment servers across all product areas. To trigger a complete data purge, either [delete your workspace](#how-can-i-delete-data-from-my-workspace) or raise a support ticket with the Customer Success team by emailing [(friends@segment.com)](mailto:friends@segment.com). In your email to Customer Success, include either the slug or the ID of the workspace that you'd like to delete. Deletions related to data purges will *not* be forwarded to your connected third-party destinations or raw data destinations. +A complete data purge is the way Segment removes all workspace and customer data from internal servers across all product areas. To trigger a complete data purge, either [delete your workspace](#how-can-i-delete-data-from-my-workspace) or raise a support ticket with the Customer Success team by emailing [(friends@segment.com)](mailto:friends@segment.com). In your email to Customer Success, include either the slug or the ID of the workspace that you'd like to delete. Deletions related to data purges will *not* be forwarded to your connected third-party destinations or raw data destinations. > error " " -> Segment waits for five days before beginning a complete data purge to safeguard against malicious deletion requests. If you notice your workspace or account has been maliciously deleted, reach out to [friends@segment.com](mailto:friends@segment.com) to cancel the data purge. After the five-day grace period, the deletion will be irreversible. \ No newline at end of file +> Segment waits for five calendar days before beginning a complete data purge to safeguard against malicious deletion requests. If you notice your workspace or account has been maliciously deleted, reach out to [friends@segment.com](mailto:friends@segment.com) to cancel the data purge. After the five-day grace period, the deletion will be irreversible. \ No newline at end of file diff --git a/src/privacy/bcr-compliance.md b/src/privacy/bcr-compliance.md index debfdd16d0..405a3be118 100644 --- a/src/privacy/bcr-compliance.md +++ b/src/privacy/bcr-compliance.md @@ -10,10 +10,10 @@ In response to the passage of the General Data Protection Regulation (GDPR) poli Twilio has two BCR policies: a [Controller policy](https://www.twilio.com/legal/bcr/controller) and a [Processor policy](https://www.twilio.com/legal/bcr/processor). Segment, as a processor of individual data, complies with the Processor policy. -### Where can I learn more about Twilio's Binding Corporate Rules? +## Where can I learn more about Twilio's Binding Corporate Rules? To learn more about Twilio's Binding Corporate Rules (BCRs,) read the [full version on twilio.com/legal](https://www.twilio.com/legal/bcr) or reach out to [privacy@twilio.com](mailto:privacy@twilio.com). -### What do Twilio's Binding Corporate Rules mean for my data? +## What do Twilio's Binding Corporate Rules mean for my data? -Twilio's BCRs inform the way your user data must be stored, processed, and deleted. While the ways Segment stores and processes user data are already in compliance with Twilio's BCRs, [an additional data deletion method](/docs/privacy/account-deletion/#delete-your-workspace-data) was introduced to comply with the ["Storage limitation"](https://www.twilio.com/legal/bcr/processor#part-ii-our-obligations) section of the Processor policy. This new data deletion method, along with the existing methods of deleting [individual user data](/docs/privacy/account-deletion/#delete-individual-user-data) and [source data](/docs/privacy/account-deletion/#delete-data-from-a-source), ensure that Segment's policies are now in alignment with Twilio's BCRs. +Twilio's BCRs inform the way your user data must be stored, processed, and deleted. While the ways Segment stores and processes user data are already in compliance with Twilio's BCRs, [an additional data deletion method](/docs/privacy/account-deletion/#delete-your-workspace-data) for all workspace data was introduced to comply with the ["Storage limitation"](https://www.twilio.com/legal/bcr/processor#part-ii-our-obligations) section of the Processor policy. This new data deletion method, along with the existing methods of deleting [individual user data](/docs/privacy/account-deletion/#delete-individual-user-data) and [source data](/docs/privacy/account-deletion/#delete-data-from-a-source), ensure that Segment's policies now align with Twilio's BCRs. From 01f21c3a54a8b4bc07f4ac4d177ece66c27f4f88 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Thu, 10 Mar 2022 14:00:46 -0500 Subject: [PATCH 15/51] Removing BCR compliance page, as per legal [netlify-build] --- src/privacy/bcr-compliance.md | 19 ------------------- 1 file changed, 19 deletions(-) delete mode 100644 src/privacy/bcr-compliance.md diff --git a/src/privacy/bcr-compliance.md b/src/privacy/bcr-compliance.md deleted file mode 100644 index 405a3be118..0000000000 --- a/src/privacy/bcr-compliance.md +++ /dev/null @@ -1,19 +0,0 @@ ---- -title: Twilio's Binding Corporate Rules (BCRs) ---- - -In response to the passage of the General Data Protection Regulation (GDPR) policy in the European Union, Twilio implemented a set of [Binding Corporate Rules (BCRs)](https://www.twilio.com/legal/binding-corporate-rules) that inform how Segment stores, processes, and deletes personal data. To align with Twilio's BCRs, Segment introduced a new data deletion process that allows customers to remove all of their users' personal data associated with a workspace 30 days after either deleting their workspace or submitting a written deletion request. - -## What are Binding Corporate Rules? - -[Binding Corporate Rules (BCRs)](https://ec.europa.eu/info/law/law-topic/data-protection/international-dimension-data-protection/binding-corporate-rules-bcr_en) are enforceable, legally binding codes of conduct that explain the ways companies store, process, and delete personal data. These codes contain information about data protection principles, tools used to protect the security of your data, and a method of accountability, or some way that proves the BCRs are externally (outside of the company) and internally (inside of the company) binding. BCRs are often specific to the storage and transfer (Controller) or processing (Processor) of personal data. - -Twilio has two BCR policies: a [Controller policy](https://www.twilio.com/legal/bcr/controller) and a [Processor policy](https://www.twilio.com/legal/bcr/processor). Segment, as a processor of individual data, complies with the Processor policy. - -## Where can I learn more about Twilio's Binding Corporate Rules? - -To learn more about Twilio's Binding Corporate Rules (BCRs,) read the [full version on twilio.com/legal](https://www.twilio.com/legal/bcr) or reach out to [privacy@twilio.com](mailto:privacy@twilio.com). - -## What do Twilio's Binding Corporate Rules mean for my data? - -Twilio's BCRs inform the way your user data must be stored, processed, and deleted. While the ways Segment stores and processes user data are already in compliance with Twilio's BCRs, [an additional data deletion method](/docs/privacy/account-deletion/#delete-your-workspace-data) for all workspace data was introduced to comply with the ["Storage limitation"](https://www.twilio.com/legal/bcr/processor#part-ii-our-obligations) section of the Processor policy. This new data deletion method, along with the existing methods of deleting [individual user data](/docs/privacy/account-deletion/#delete-individual-user-data) and [source data](/docs/privacy/account-deletion/#delete-data-from-a-source), ensure that Segment's policies now align with Twilio's BCRs. From b8ea3dbac5d7784ac139bd1f06f82c4a3ce0f3bc Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Thu, 10 Mar 2022 14:14:38 -0500 Subject: [PATCH 16/51] Removing BCR from main nav [netlify-build] --- src/_data/sidenav/main.yml | 3 --- 1 file changed, 3 deletions(-) diff --git a/src/_data/sidenav/main.yml b/src/_data/sidenav/main.yml index c294843cb4..aade032125 100644 --- a/src/_data/sidenav/main.yml +++ b/src/_data/sidenav/main.yml @@ -322,9 +322,6 @@ sections: title: Complying With GDPR - path: /privacy/user-deletion-and-suppression title: User Deletion and Suppression - - path: /privacy/bcr-compliance - title: Twilio's Binding Corporate Rules - - path: /privacy/account-deletion title: Account & Data Deletion - path: /privacy/faq title: Privacy FAQs From 528e5d5fe4bb20e6d8ba63de0a2c919dc5312709 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Thu, 10 Mar 2022 14:28:11 -0500 Subject: [PATCH 17/51] Fixing side nav [netlify-build] --- src/_data/sidenav/main.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/src/_data/sidenav/main.yml b/src/_data/sidenav/main.yml index aade032125..eb4abca6c2 100644 --- a/src/_data/sidenav/main.yml +++ b/src/_data/sidenav/main.yml @@ -322,6 +322,7 @@ sections: title: Complying With GDPR - path: /privacy/user-deletion-and-suppression title: User Deletion and Suppression + - path: /privacy/account-deletion title: Account & Data Deletion - path: /privacy/faq title: Privacy FAQs From f5457fa222427c7760d8f4d7d01dbfcef6c31e32 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Tue, 15 Mar 2022 16:00:47 -0400 Subject: [PATCH 18/51] DOC-460 Small change requested by Legal --- src/privacy/account-deletion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/privacy/account-deletion.md b/src/privacy/account-deletion.md index 27642d232b..68cfafda75 100644 --- a/src/privacy/account-deletion.md +++ b/src/privacy/account-deletion.md @@ -10,7 +10,7 @@ To delete the data for an individual user from you workspace, follow the instruc ## Delete data from a source To delete the data for an entire source, email the Customer Success team [(friends@segment.com)](mailto:friends@segment.com) to create a support ticket. In your email to Customer Success, include the following information: - Your workplace slug -- The source you'd like to delete data from +- The source from which you'd like to delete data - The time frame for the data you'd like to delete* **Due to the way Segment stores data internally, source-level deletions can only be scoped to one day in granularity. Deletion requests for smaller time frames are not supported.* From 1e5cd2c774d668c5f89567c0444faf39f39d6bb6 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 16 Mar 2022 11:49:00 -0400 Subject: [PATCH 19/51] [netlify-build] --- src/privacy/account-deletion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/privacy/account-deletion.md b/src/privacy/account-deletion.md index 68cfafda75..010aac5d62 100644 --- a/src/privacy/account-deletion.md +++ b/src/privacy/account-deletion.md @@ -47,4 +47,4 @@ If you do not delete your workspace after you stop using Segment, **your data re A complete data purge is the way Segment removes all workspace and customer data from internal servers across all product areas. To trigger a complete data purge, either [delete your workspace](#how-can-i-delete-data-from-my-workspace) or raise a support ticket with the Customer Success team by emailing [(friends@segment.com)](mailto:friends@segment.com). In your email to Customer Success, include either the slug or the ID of the workspace that you'd like to delete. Deletions related to data purges will *not* be forwarded to your connected third-party destinations or raw data destinations. > error " " -> Segment waits for five calendar days before beginning a complete data purge to safeguard against malicious deletion requests. If you notice your workspace or account has been maliciously deleted, reach out to [friends@segment.com](mailto:friends@segment.com) to cancel the data purge. After the five-day grace period, the deletion will be irreversible. \ No newline at end of file +> Segment waits for five calendar days before beginning a complete data purge to safeguard against malicious deletion requests. If you notice your workspace or account has been maliciously deleted, reach out to [friends@segment.com](mailto:friends@segment.com) to cancel the data purge. After the five-day grace period, the deletion will be irreversible. From d56882d26090cbb9531fc5ddf54e0349fe5c979e Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 16 Mar 2022 11:51:30 -0400 Subject: [PATCH 20/51] [netlify-build] --- src/privacy/account-deletion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/privacy/account-deletion.md b/src/privacy/account-deletion.md index 010aac5d62..68cfafda75 100644 --- a/src/privacy/account-deletion.md +++ b/src/privacy/account-deletion.md @@ -47,4 +47,4 @@ If you do not delete your workspace after you stop using Segment, **your data re A complete data purge is the way Segment removes all workspace and customer data from internal servers across all product areas. To trigger a complete data purge, either [delete your workspace](#how-can-i-delete-data-from-my-workspace) or raise a support ticket with the Customer Success team by emailing [(friends@segment.com)](mailto:friends@segment.com). In your email to Customer Success, include either the slug or the ID of the workspace that you'd like to delete. Deletions related to data purges will *not* be forwarded to your connected third-party destinations or raw data destinations. > error " " -> Segment waits for five calendar days before beginning a complete data purge to safeguard against malicious deletion requests. If you notice your workspace or account has been maliciously deleted, reach out to [friends@segment.com](mailto:friends@segment.com) to cancel the data purge. After the five-day grace period, the deletion will be irreversible. +> Segment waits for five calendar days before beginning a complete data purge to safeguard against malicious deletion requests. If you notice your workspace or account has been maliciously deleted, reach out to [friends@segment.com](mailto:friends@segment.com) to cancel the data purge. After the five-day grace period, the deletion will be irreversible. \ No newline at end of file From f55d84c71c8265a74e4bc1c184610bdef1bb9972 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 16 Mar 2022 12:01:27 -0400 Subject: [PATCH 21/51] [netlify-build] --- src/privacy/account-deletion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/privacy/account-deletion.md b/src/privacy/account-deletion.md index 68cfafda75..2d898a7182 100644 --- a/src/privacy/account-deletion.md +++ b/src/privacy/account-deletion.md @@ -10,7 +10,7 @@ To delete the data for an individual user from you workspace, follow the instruc ## Delete data from a source To delete the data for an entire source, email the Customer Success team [(friends@segment.com)](mailto:friends@segment.com) to create a support ticket. In your email to Customer Success, include the following information: - Your workplace slug -- The source from which you'd like to delete data +- The source from which you'd like to delete data - The time frame for the data you'd like to delete* **Due to the way Segment stores data internally, source-level deletions can only be scoped to one day in granularity. Deletion requests for smaller time frames are not supported.* From 62a605b4555fb53e9867fbcaa1d0aed4a02b0619 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 16 Mar 2022 12:13:47 -0400 Subject: [PATCH 22/51] DOC-460 netlify troubleshooting [netlify-build] --- src/privacy/account-deletion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/privacy/account-deletion.md b/src/privacy/account-deletion.md index 2d898a7182..27642d232b 100644 --- a/src/privacy/account-deletion.md +++ b/src/privacy/account-deletion.md @@ -10,7 +10,7 @@ To delete the data for an individual user from you workspace, follow the instruc ## Delete data from a source To delete the data for an entire source, email the Customer Success team [(friends@segment.com)](mailto:friends@segment.com) to create a support ticket. In your email to Customer Success, include the following information: - Your workplace slug -- The source from which you'd like to delete data +- The source you'd like to delete data from - The time frame for the data you'd like to delete* **Due to the way Segment stores data internally, source-level deletions can only be scoped to one day in granularity. Deletion requests for smaller time frames are not supported.* From 9d9c3a731cd32167da6d71962d84c0d4ad3265c3 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 16 Mar 2022 12:25:28 -0400 Subject: [PATCH 23/51] Fixing changes [netlify-build] --- src/privacy/account-deletion.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/privacy/account-deletion.md b/src/privacy/account-deletion.md index 27642d232b..68cfafda75 100644 --- a/src/privacy/account-deletion.md +++ b/src/privacy/account-deletion.md @@ -10,7 +10,7 @@ To delete the data for an individual user from you workspace, follow the instruc ## Delete data from a source To delete the data for an entire source, email the Customer Success team [(friends@segment.com)](mailto:friends@segment.com) to create a support ticket. In your email to Customer Success, include the following information: - Your workplace slug -- The source you'd like to delete data from +- The source from which you'd like to delete data - The time frame for the data you'd like to delete* **Due to the way Segment stores data internally, source-level deletions can only be scoped to one day in granularity. Deletion requests for smaller time frames are not supported.* From 7be19c95f063afcb029471bb913a70bc5b7d08b0 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Fri, 18 Mar 2022 09:28:21 -0400 Subject: [PATCH 24/51] DOC-452 Vale updates, adding table headers --- .../catalog/cloud-apps/zendesk/index.md | 89 ++++++++++++++----- 1 file changed, 66 insertions(+), 23 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index 6b5564c709..c4a5a4d717 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -6,7 +6,6 @@ id: 3hbak7a9 [Zendesk](https://www.zendesk.com/) is a customer service platform for enterprises, which provides a customer support platform that allows quicker and easier interaction between businesses and customers. -If you notice any gaps, outdated information or simply want to leave some feedback to help us improve our documentation, [let us know](https://segment.com/help/contact)! ## Getting Started @@ -14,60 +13,64 @@ If you notice any gaps, outdated information or simply want to leave some feedba 2. Choose Zendesk. -3. Give the Source a name and add any labels to help you organize and filter your sources. You can give the source any name, but Segment recommends a name that reflects the source itself, as this name autopopulates the schema name. For example, the source name `Zendesk` creates the schema `zendesk`. +3. Give the Source a name and add any labels to help you organize and filter your sources. You can give the source any name, but Segment recommends a name that reflects the source itself, as this name auto-populates the schema name. For example, the source name `Zendesk` creates the schema `zendesk`. - **Note**: You can add multiple instances if you have multiple Zendesk accounts. That's why we allow you to customize the source's nickname and schema name! + **Note**: You can add multiple instances if you have multiple Zendesk accounts. That's why Segment allows you to customize the source's nickname and schema name. -4. Enter your Zendesk subdomain. The subdomain you use to access your Zendesk portal (e.g. 'segment' for segment.zendesk.com) +4. Enter your Zendesk subdomain. The subdomain you use to access your Zendesk portal (for example 'segment' for segment.zendesk.com) **Note** If you enter `segment.zendesk.com` as a subdomain instead of just `segment`, Segment tries to access the host `segment.zendesk.com.zendesk.com` and you will get a credentials error. -5. Click **Authorize** to start Zendesk's OAuth process. Sign in and grant permissions, you'll be good to go! +5. Click **Authorize** to start Zendesk's OAuth process. Sign in and grant permissions, you'll be good to go. > success "" -> **Tip**: Segment uses the incremental export API from Zendesk, which requires Admin access. Make sure the user has Admin authorizations! +> **Tip**: Segment uses the incremental export API from Zendesk, which requires Admin access. Make sure the user has Admin authorizations. ### Rate Limits -The Zendesk source uses both Zendesk's [Core API](https://developer.zendesk.com/api-reference/) and [Incremental Exports API](https://developer.zendesk.com/rest_api/docs/core/incremental_export). The source's requests to the Incremental API do not count towards your Zendesk account's rate limits, but requests to the Core API do. By default, we cap our requests to Zendesk's Core API to a rate of 200 requests per minute to avoid triggering [Zendesk's Rate Limits](https://developer.zendesk.com/api-reference/ticketing/account-configuration/usage_limits/). If you'd like us to increase or decrease the request rate for your source, [let us know](https://segment.com/help/contact/), and we'll get it set up. We'll add support for this in the UI soon! +The Zendesk source uses both Zendesk's [Core API](https://developer.zendesk.com/api-reference/) and [Incremental Exports API](https://developer.zendesk.com/rest_api/docs/core/incremental_export). The source's requests to the Incremental API do not count towards your Zendesk account's rate limits, but requests to the Core API do. By default, Segment caps requests to Zendesk's Core API to a rate of 200 requests per minute to avoid triggering [Zendesk's Rate Limits](https://developer.zendesk.com/api-reference/ticketing/account-configuration/usage_limits/). If you'd like to increase or decrease the request rate for your source, [please reach out](https://segment.com/help/contact/). Support for this in the UI is in the works. ## Components ### Sync -The Zendesk source is built with a sync component, which means we'll make requests to their API on your behalf on a 3 hour interval to pull the latest data into Segment. In the initial sync, we'll grab all the Zendesk objects (and their corresponding properties) according to the Collections Table below. The objects will be written into a separate schema, corresponding to the source instance's schema name you designated upon creation (ie. `zendesk_prod.users`). +The Zendesk source is built with a sync component, which means Segment makes requests to their API on your behalf on a three hour interval to pull the latest data into Segment. In the initial sync, Segment grabs all the Zendesk objects (and their corresponding properties) according to the Collections Table below. The objects will be written into a separate schema, corresponding to the source instance's schema name you designated upon creation (like `zendesk_prod.users`). -Our sync component uses an upsert API, so the data in your warehouse loaded using sync will reflect the latest state of the corresponding resource in Zendesk. For example, if `ticket_status` goes from `open` to `closed` between syncs, on its next sync that tickets status will be `closed`. +The sync component uses an upsert API, so the data in your warehouse loaded using sync will reflect the latest state of the corresponding resource in Zendesk. For example, if `ticket_status` goes from `open` to `closed` between syncs, on its next sync that tickets status will be `closed`. -The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources will sync with Segment every 3 hours. Depending on your Warehouses plan, we will push the Source data to your warehouse on the interval associated with your billing plan. +The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources will sync with Segment every three hours. Depending on your Warehouses plan, Segment pushes the Source data to your warehouse on the interval associated with your billing plan. -At the moment, we don't support filtering which objects or properties get synced. If you're interested in this feature, [let us know](https://segment.com/help/contact/)! +At the moment, Segment doesn't support filtering which objects or properties get synced. If you're interested in this feature, [please reach out](https://segment.com/help/contact/). ## Collections -Collections are the groupings of resources we pull from your source. +Collections are the groupings of resources Segment pulls from your source. | Collection | Type | Description | | ------ | ------ | ------ | -| users | object | Zendesk Support has three types of users: end-users (your customers), agents, and administrators. End-users request support through tickets. Agents work in Zendesk Support to solve tickets. Agents can be divided into multiple groups and can also belong to multiple groups. Agents don't have access to administrative configuration in Zendesk Support such as business rules or automations, but can configure their own macros and views. Administrators have all the abilities of agents, plus administrative abilities. | +| users | object | Zendesk Support has three types of users: end-users (your customers), agents, and administrators. End-users request support through tickets. Agents work in Zendesk Support to solve tickets. Agents can be divided into multiple groups and can also belong to multiple groups. Agents don't have access to administrative configuration in Zendesk Support such as business rules or automation, but can configure their own macros and views. Administrators have all the abilities of agents, plus administrative abilities. | | groups | object | When support requests arrive in Zendesk, they can be assigned to a Group. Groups serve as the core element of ticket workflow; support agents are organized into Groups and tickets can be assigned to a Group only, or to an assigned agent within a Group. A ticket can never be assigned to an agent without also being assigned to a Group. | -| tickets | object | Tickets are the means through which your End-users (customers) communicate with Agents in Zendesk. **Note**: We pull all tickets updated (or created) in the last year to start by default. If you need more, just let us know and we'll do a run to pull further back in history. | +| tickets | object | Tickets are the means through which your End-users (customers) communicate with Agents in Zendesk. **Note**: Segment pulls all tickets updated (or created) in the last year to start by default. If you need more, reach out to Segment support. Support can do a run to pull further back in history. | | ticket_fields | object | Customize fields on the ticket form. | | activities | object | The activity stream is a per agent event stream. It will give access to the most recent events that relate to the agent polling the API. | | attachments | object | This API is for attachments in tickets and forum posts in the Web portal. | | organizations | object | Just as agents can be segmented into groups in Zendesk, your customers (end-users) can be segmented into organizations. | -| ticket_events | events | Returns a stream of changes that occurred on tickets. Each event is tied to an update on a ticket and contains all the fields that were updated in that change. **Note**: We pull 1 year of ticket events to start by default. If you need more, just let us know and we'll do a run to pull further back in history.| +| ticket_events | events | Returns a stream of changes that occurred on tickets. Each event is tied to an update on a ticket and contains all the fields that were updated in that change. **Note**: Segment pulls one year of ticket events to start by default. If you need more, reach out to Segment support. Support can do a run to pull further back in history. | | ticket_metrics | object | All kinds of aggregate metrics about a ticket | | satisfaction_ratings | object | If you have enabled satisfaction ratings for your account, this end point allows you to quickly retrieve all ratings. | -| ticket_comments | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact us]https://segment.com/help/contact/. | +| ticket_comments | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support]https://segment.com/help/contact/. | -In your warehouse, each collection gets its own table. Find below a list of the properties we automatically fetch for each collection. -**Note** The list in this document includes the standard properties only, but doesn't include _your_ custom fields. (Don't worry, they'll be there in your warehouse!) +In your warehouse, each collection gets its own table. Find below a list of the properties Segment automatically fetches for each collection. +**Note** The list in this document includes the standard properties only, but doesn't include _your_ custom fields. (Don't worry, they'll be there in your warehouse.) ### groups + + + + @@ -100,13 +103,17 @@ In your warehouse, each collection gets its own table. Find below a list of the ### users
PropertyDescription
id Automatically assigned when creating groups.
+ + + + - + @@ -228,6 +235,10 @@ In your warehouse, each collection gets its own table. Find below a list of the ### tickets
PropertyDescription
id Automatically assigned when the user is created.
url We set the "url" field users see in their Warehouse to equal the "id" from Zendesk, rather than the "url" field. Segment sets the "url" field users see in their Warehouse to equal the "id" from Zendesk, rather than the "url" field.
name
+ + + + @@ -282,7 +293,7 @@ In your warehouse, each collection gets its own table. Find below a list of the - + @@ -332,6 +343,10 @@ In your warehouse, each collection gets its own table. Find below a list of the ### ticket_fields
PropertyDescription
id Automatically assigned when the ticket is created.
organization_id The organization of the requester. You can only specify the ID of an organization associated with the requestert. The organization of the requester. You can only specify the ID of an organization associated with the requester.
group_id
+ + + + @@ -427,6 +442,10 @@ In your warehouse, each collection gets its own table. Find below a list of the ### ticket_metrics
PropertyDescription
id Automatically assigned upon creation.
+ + + + @@ -541,6 +560,10 @@ In your warehouse, each collection gets its own table. Find below a list of the ### ticket_events
PropertyDescription
id Automatically assigned.
+ + + + @@ -567,11 +590,11 @@ In your warehouse, each collection gets its own table. Find below a list of the - + - + @@ -593,6 +616,10 @@ In your warehouse, each collection gets its own table. Find below a list of the ### activities
PropertyDescription
id Automatically assigned.
context_client Refers to the "client" used to submit this ticket change (i.e. browser name and type). Refers to the "client" used to submit this ticket change (for example, browser name and type).
context_location Plain text name of where the request was made, if available (i.e. country, city). Plain text name of where the request was made, if available (for example, country, city).
context_latitude
+ + + + @@ -621,6 +648,10 @@ In your warehouse, each collection gets its own table. Find below a list of the ### attachments
PropertyDescription
id Automatically assigned upon creation.
+ + + + @@ -653,6 +684,10 @@ In your warehouse, each collection gets its own table. Find below a list of the ### organizations
PropertyDescription
id Automatically assigned upon creation.
+ + + + @@ -671,7 +706,7 @@ In your warehouse, each collection gets its own table. Find below a list of the - + @@ -705,6 +740,10 @@ In your warehouse, each collection gets its own table. Find below a list of the ### satisfaction_ratings
PropertyDescription
id Automatically assigned when the organization is created.
details Any details obout the organization, such as the address. Any details about the organization, such as the address.
notes
+ + + + @@ -748,6 +787,10 @@ In your warehouse, each collection gets its own table. Find below a list of the ### ticket_comments
PropertyDescription
id Automatically assigned when the organization is created.
+ + + + From 99365233572f48d720d2fe2ca7ef694aedf0360e Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Fri, 18 Mar 2022 11:55:24 -0400 Subject: [PATCH 25/51] DOC-452 Updating collections table, adding tables for each new collection --- .../catalog/cloud-apps/zendesk/index.md | 263 ++++++++++++++++-- 1 file changed, 245 insertions(+), 18 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index c4a5a4d717..32cf7711cc 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -61,9 +61,16 @@ Collections are the groupings of resources Segment pulls from your source. | ticket_metrics | object | All kinds of aggregate metrics about a ticket | | satisfaction_ratings | object | If you have enabled satisfaction ratings for your account, this end point allows you to quickly retrieve all ratings. | | ticket_comments | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support]https://segment.com/help/contact/. | +| ticket_forms | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support]https://segment.com/help/contact/. | +| audit_logs | events | The audit log shows various changes in your instance of Zendesk since the account was created. **Note**: This collection is not included by default. To request it, [contact Segment support]https://segment.com/help/contact/. | +| organization_memberships | object | A membership links a user to an organization. Organizations can have many users. Users can be in many organizations if the account supports multiple organizations. You can use the API to list users in an organization, and reassign organization members. | +| group_memberships | object | A membership links an agent to a group. Groups can have many agents, as agents can be in many groups. You can use the API to list what agents are in which groups, and reassign group members. | +| ticket_skips | events | A skip is a record of when an agent skips over a ticket without responding to the end user. | In your warehouse, each collection gets its own table. Find below a list of the properties Segment automatically fetches for each collection. -**Note** The list in this document includes the standard properties only, but doesn't include _your_ custom fields. (Don't worry, they'll be there in your warehouse.) + +> note "Standard properties" +> The list in this document includes the standard properties only, but doesn't include _your_ custom fields. (Don't worry, they'll be there in your warehouse.) ### groups
PropertyDescription
id Automatically assigned when the comment is created.
@@ -141,7 +148,7 @@ In your warehouse, each collection gets its own table. Find below a list of the - + @@ -153,7 +160,7 @@ In your warehouse, each collection gets its own table. Find below a list of the - + @@ -249,7 +256,7 @@ In your warehouse, each collection gets its own table. Find below a list of the - + @@ -301,7 +308,7 @@ In your warehouse, each collection gets its own table. Find below a list of the - + @@ -325,7 +332,7 @@ In your warehouse, each collection gets its own table. Find below a list of the - + @@ -339,6 +346,10 @@ In your warehouse, each collection gets its own table. Find below a list of the + + + +
organization_id The id of the organization this user is associated with. The ID of the organization this user is associated with.
role
external_id A unique identifier from another system. The API treats the id as case insensitive. Example: ian1 and Ian1 are the same user. A unique identifier from another system. The API treats the ID as case insensitive. Example: ian1 and Ian1 are the same user.
alias
external_id An id you can use to link Zendesk Support tickets to local records. An ID you can use to link Zendesk Support tickets to local records.
type
collaborator_ids The ids of users currently cc'ed on the ticket. The IDs of users currently cc'ed on the ticket.
forum_topic_id
sharing_agreement_ids The ids of the sharing agreements used for this ticket. The IDs of the sharing agreements used for this ticket.
created_atreceived_at This timestamp is added to incoming messages as soon as they hit Segment API.
ticket_form_idThe ID of the ticket form to render for the ticket (Enterprise only).
### ticket_fields @@ -397,7 +408,7 @@ In your warehouse, each collection gets its own table. Find below a list of the regexp_for_validation - Regular expression field only. The validation pattern for a field value to be deemed valid.. + Regular expression field only. The validation pattern for a field value to be deemed valid. title_in_portal @@ -452,7 +463,7 @@ In your warehouse, each collection gets its own table. Find below a list of the ticket_id - Id of the associated ticket. + ID of the associated ticket. group_stations @@ -574,7 +585,7 @@ In your warehouse, each collection gets its own table. Find below a list of the ticket_id - Id of the associated ticket. + ID of the associated ticket. timestamp @@ -582,7 +593,7 @@ In your warehouse, each collection gets its own table. Find below a list of the updater_id - Id of the user who updated the ticket. + ID of the user who updated the ticket. ticket_event_via @@ -694,7 +705,7 @@ In your warehouse, each collection gets its own table. Find below a list of the external_id - A unique external id to associate organizations to an external record. + A unique external ID to associate organizations to an external record. url @@ -753,19 +764,19 @@ In your warehouse, each collection gets its own table. Find below a list of the assignee_id - The id of agent assigned to at the time of rating. + The ID of agent assigned to at the time of rating. group_id - The id of group assigned to at the time of rating. + The ID of group assigned to at the time of rating. requester_id - The id of ticket requester submitting the rating. + The ID of ticket requester submitting the rating. ticket_id - The id of ticket being rated. + The ID of ticket being rated. score @@ -800,7 +811,7 @@ In your warehouse, each collection gets its own table. Find below a list of the ticket_id - The id of ticket being commented. + The ID of ticket being commented. type @@ -816,7 +827,7 @@ In your warehouse, each collection gets its own table. Find below a list of the author_id - The id of the comment author. + The ID of the comment author. via @@ -832,5 +843,221 @@ In your warehouse, each collection gets its own table. Find below a list of the +### ticket_forms + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
idAutomatically assigned when creating groups.
activeShows if the form is set as active.
end_user_visibleShows if the form is visible to the end user.
nameThe name of the form.
restricted_brand_idsIDs of all brands that this ticket form is restricted to.
ticket_field_idsIDs of all ticket fields which are in this ticket form.
updated_atThe time of the last update of the ticket form.
url The API url of this ticket.
created_atThe time the ticket form was created.
display_nameThe name of the form that is displayed to the end user.
in_all_brandsShows if the form is available for use in all brands on this account.
positionThe position of this form among other forms in the account (for example, dropdown)
raw_display_nameThe dynamic content placeholder (if available,) or the "display_name" value, if the dynamic content placeholder is unavailable.
raw_nameThe dynamic content placeholder (if available,) or the "name" value, if the dynamic content placeholder is unavailable.
defaultShows if this form is the default form for this account.
+ +### audit_logs + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
idAutomatically assigned when creating groups.
url The API url of this ticket.
created_atThe time the audit got created.
actor_idThe ID of the user creating the ticket
source_idThe ID of the item being audited.
source_typeThe item type being audited.
source_labelThe name of the item being audited.
actionThe action a user performed. Either "login", "create", "update", or "destroy".
change_descriptionThe description of the change that occurred.
ip_addressThe IP address of the user performing the audit.
action_labelA localized string of action field.
+ +### organization_memberships + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
idAutomatically assigned when creating groups.
url The API url of this ticket.
user_idThe ID of the user who has this organization membership.
organization_idthe ID of the organization associated with this user.
created_atWhen this record was created.
updated_atWhen this record was last updated.
organization_nameThe name of the organization associated with this user.
+ +### group_memberships + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
id Automatically assigned when creating groups.
url The API url of this group.
created_at The time the group was created.
group_id The ID of the group assigned to at the time of rating.
updated_at The time of the last update of the group.
user_id The ID of an agent.
+ +### ticket_skips + + + + + + + + + + + + + + + + + + + + + + + + + +
PropertyDescription
idAutomatically assigned when creating groups.
user_idID of the skipping agent.
reasonReason for skipping the ticket.
created_atTime the skip was created.
updated_atTime the skip was last updated.
+ ## Adding Destinations -Currently only Warehouses are supported for object-cloud sources +Currently only Warehouses are supported for object-cloud sources. From f2c65ec1f55d9df47b02304a036eb36d27dbe1b1 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Fri, 18 Mar 2022 14:07:45 -0400 Subject: [PATCH 26/51] DOC-452 Fixing links --- .../sources/catalog/cloud-apps/zendesk/index.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index 32cf7711cc..cc13a96fd7 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -57,12 +57,12 @@ Collections are the groupings of resources Segment pulls from your source. | activities | object | The activity stream is a per agent event stream. It will give access to the most recent events that relate to the agent polling the API. | | attachments | object | This API is for attachments in tickets and forum posts in the Web portal. | | organizations | object | Just as agents can be segmented into groups in Zendesk, your customers (end-users) can be segmented into organizations. | -| ticket_events | events | Returns a stream of changes that occurred on tickets. Each event is tied to an update on a ticket and contains all the fields that were updated in that change. **Note**: Segment pulls one year of ticket events to start by default. If you need more, reach out to Segment support. Support can do a run to pull further back in history. | +| ticket_events | events | Returns a stream of changes that occurred on tickets. Each event is tied to an update on a ticket and contains all the fields that were updated in that change. **Note**: Segment pulls one year of ticket events to start by default. If you need more, reach out to [Segment support](https://segment.com/help/contact/). Support can do a run to pull further back in history. | | ticket_metrics | object | All kinds of aggregate metrics about a ticket | | satisfaction_ratings | object | If you have enabled satisfaction ratings for your account, this end point allows you to quickly retrieve all ratings. | -| ticket_comments | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support]https://segment.com/help/contact/. | -| ticket_forms | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support]https://segment.com/help/contact/. | -| audit_logs | events | The audit log shows various changes in your instance of Zendesk since the account was created. **Note**: This collection is not included by default. To request it, [contact Segment support]https://segment.com/help/contact/. | +| ticket_comments | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | +| ticket_forms | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | +| audit_logs | events | The audit log shows various changes in your instance of Zendesk since the account was created. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | | organization_memberships | object | A membership links a user to an organization. Organizations can have many users. Users can be in many organizations if the account supports multiple organizations. You can use the API to list users in an organization, and reassign organization members. | | group_memberships | object | A membership links an agent to a group. Groups can have many agents, as agents can be in many groups. You can use the API to list what agents are in which groups, and reassign group members. | | ticket_skips | events | A skip is a record of when an agent skips over a ticket without responding to the end user. | From eb582a5f3aca2b76ad73f8e9d49eee51d3a2d50a Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Mon, 21 Mar 2022 10:49:00 -0400 Subject: [PATCH 27/51] Updating the type for two new collections DOC-452 --- src/connections/sources/catalog/cloud-apps/zendesk/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index cc13a96fd7..6a67779d8d 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -62,10 +62,10 @@ Collections are the groupings of resources Segment pulls from your source. | satisfaction_ratings | object | If you have enabled satisfaction ratings for your account, this end point allows you to quickly retrieve all ratings. | | ticket_comments | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | | ticket_forms | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | -| audit_logs | events | The audit log shows various changes in your instance of Zendesk since the account was created. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | +| audit_logs | object | The audit log shows various changes in your instance of Zendesk since the account was created. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | | organization_memberships | object | A membership links a user to an organization. Organizations can have many users. Users can be in many organizations if the account supports multiple organizations. You can use the API to list users in an organization, and reassign organization members. | | group_memberships | object | A membership links an agent to a group. Groups can have many agents, as agents can be in many groups. You can use the API to list what agents are in which groups, and reassign group members. | -| ticket_skips | events | A skip is a record of when an agent skips over a ticket without responding to the end user. | +| ticket_skips | object | A skip is a record of when an agent skips over a ticket without responding to the end user. | In your warehouse, each collection gets its own table. Find below a list of the properties Segment automatically fetches for each collection. From 8b086a1e0f33605ebc6134448e7d15b0e8c12828 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Mon, 21 Mar 2022 12:32:43 -0400 Subject: [PATCH 28/51] DOC-453 Updating the order of new properties, linking the property in the table to each collection --- .../catalog/cloud-apps/zendesk/index.md | 121 +++++++++--------- 1 file changed, 61 insertions(+), 60 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index 6a67779d8d..8eb61c2241 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -50,22 +50,23 @@ Collections are the groupings of resources Segment pulls from your source. | Collection | Type | Description | | ------ | ------ | ------ | -| users | object | Zendesk Support has three types of users: end-users (your customers), agents, and administrators. End-users request support through tickets. Agents work in Zendesk Support to solve tickets. Agents can be divided into multiple groups and can also belong to multiple groups. Agents don't have access to administrative configuration in Zendesk Support such as business rules or automation, but can configure their own macros and views. Administrators have all the abilities of agents, plus administrative abilities. | -| groups | object | When support requests arrive in Zendesk, they can be assigned to a Group. Groups serve as the core element of ticket workflow; support agents are organized into Groups and tickets can be assigned to a Group only, or to an assigned agent within a Group. A ticket can never be assigned to an agent without also being assigned to a Group. | -| tickets | object | Tickets are the means through which your End-users (customers) communicate with Agents in Zendesk. **Note**: Segment pulls all tickets updated (or created) in the last year to start by default. If you need more, reach out to Segment support. Support can do a run to pull further back in history. | -| ticket_fields | object | Customize fields on the ticket form. | -| activities | object | The activity stream is a per agent event stream. It will give access to the most recent events that relate to the agent polling the API. | -| attachments | object | This API is for attachments in tickets and forum posts in the Web portal. | -| organizations | object | Just as agents can be segmented into groups in Zendesk, your customers (end-users) can be segmented into organizations. | -| ticket_events | events | Returns a stream of changes that occurred on tickets. Each event is tied to an update on a ticket and contains all the fields that were updated in that change. **Note**: Segment pulls one year of ticket events to start by default. If you need more, reach out to [Segment support](https://segment.com/help/contact/). Support can do a run to pull further back in history. | -| ticket_metrics | object | All kinds of aggregate metrics about a ticket | -| satisfaction_ratings | object | If you have enabled satisfaction ratings for your account, this end point allows you to quickly retrieve all ratings. | -| ticket_comments | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | -| ticket_forms | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | -| audit_logs | object | The audit log shows various changes in your instance of Zendesk since the account was created. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | -| organization_memberships | object | A membership links a user to an organization. Organizations can have many users. Users can be in many organizations if the account supports multiple organizations. You can use the API to list users in an organization, and reassign organization members. | -| group_memberships | object | A membership links an agent to a group. Groups can have many agents, as agents can be in many groups. You can use the API to list what agents are in which groups, and reassign group members. | -| ticket_skips | object | A skip is a record of when an agent skips over a ticket without responding to the end user. | +| [users](#users) | object | Zendesk Support has three types of users: end-users (your customers), agents, and administrators. End-users request support through tickets. Agents work in Zendesk Support to solve tickets. Agents can be divided into multiple groups and can also belong to multiple groups. Agents don't have access to administrative configuration in Zendesk Support such as business rules or automation, but can configure their own macros and views. Administrators have all the abilities of agents, plus administrative abilities. | +| [groups](#groups) | object | When support requests arrive in Zendesk, they can be assigned to a Group. Groups serve as the core element of ticket workflow; support agents are organized into Groups and tickets can be assigned to a Group only, or to an assigned agent within a Group. A ticket can never be assigned to an agent without also being assigned to a Group. | +| [tickets](#tickets) | object | Tickets are the means through which your End-users (customers) communicate with Agents in Zendesk. **Note**: Segment pulls all tickets updated (or created) in the last year to start by default. If you need more, reach out to Segment support. Support can do a run to pull further back in history. | +| [ticket_fields](#ticketfields) | object | Customize fields on the ticket form. | +| [activities](#activities) | object | The activity stream is a per agent event stream. It will give access to the most recent events that relate to the agent polling the API. | +| [attachments](#activities) | object | This API is for attachments in tickets and forum posts in the Web portal. | +| [organizations](#organizations) | object | Just as agents can be segmented into groups in Zendesk, your customers (end-users) can be segmented into organizations. | +| [ticket_events](#ticketevents) | events | Returns a stream of changes that occurred on tickets. Each event is tied to an update on a ticket and contains all the fields that were updated in that change. **Note**: Segment pulls one year of ticket events to start by default. If you need more, reach out to [Segment support](https://segment.com/help/contact/). Support can do a run to pull further back in history. | +| [ticket_metrics](#ticketmetrics) | object | All kinds of aggregate metrics about a ticket | +| [satisfaction_ratings](#satisfactionratings) | object | If you have enabled satisfaction ratings for your account, this end point allows you to quickly retrieve all ratings. | +| [ticket_comments](#ticketcomments) | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | +| [ticket_forms](#ticketforms) | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | +| [ticket_skips](#ticketskips) | object | A skip is a record of when an agent skips over a ticket without responding to the end user. | +| [organization_memberships](#organizationmemberships) | object | A membership links a user to an organization. Organizations can have many users. Users can be in many organizations if the account supports multiple organizations. You can use the API to list users in an organization, and reassign organization members. | +| [group_memberships](#groupmemberships) | object | A membership links an agent to a group. Groups can have many agents, as agents can be in many groups. You can use the API to list what agents are in which groups, and reassign group members. | +| [audit_logs](#auditlogs) | object | The audit log shows various changes in your instance of Zendesk since the account was created. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | + In your warehouse, each collection gets its own table. Find below a list of the properties Segment automatically fetches for each collection. @@ -911,7 +912,7 @@ In your warehouse, each collection gets its own table. Find below a list of the -### audit_logs +### ticket_skips @@ -919,47 +920,23 @@ In your warehouse, each collection gets its own table. Find below a list of the - - - - - - - - - - - - - - - - - - - - - - - - - + - - + + - - + + - - + + - - + +
Property
idAutomatically assigned when creating groups.
url The API url of this ticket.
created_atThe time the audit got created.
actor_idThe ID of the user creating the ticket
source_idThe ID of the item being audited.
source_typeThe item type being audited.
source_labelThe name of the item being audited.Automatically assigned when creating groups.
actionThe action a user performed. Either "login", "create", "update", or "destroy".user_idID of the skipping agent.
change_descriptionThe description of the change that occurred.reasonReason for skipping the ticket.
ip_addressThe IP address of the user performing the audit.created_atTime the skip was created.
action_labelA localized string of action field.updated_atTime the skip was last updated.
@@ -1031,7 +1008,7 @@ In your warehouse, each collection gets its own table. Find below a list of the -### ticket_skips +### audit_logs @@ -1039,23 +1016,47 @@ In your warehouse, each collection gets its own table. Find below a list of the - + - - + + - - + + - - + + - - + + + + + + + + + + + + + + + + + + + + + + + + + +
Property
idAutomatically assigned when creating groups.Automatically assigned when creating groups.
user_idID of the skipping agent.url The API url of this ticket.
reasonReason for skipping the ticket.created_atThe time the audit got created.
created_atTime the skip was created.actor_idThe ID of the user creating the ticket
updated_atTime the skip was last updated.source_idThe ID of the item being audited.
source_typeThe item type being audited.
source_labelThe name of the item being audited.
actionThe action a user performed. Either "login", "create", "update", or "destroy".
change_descriptionThe description of the change that occurred.
ip_addressThe IP address of the user performing the audit.
action_labelA localized string of action field.
From 8cd0bdd14efe6be92403686da05af2cef8926b35 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Tue, 22 Mar 2022 08:30:26 -0400 Subject: [PATCH 29/51] DOC-452 Removing mystery property --- src/connections/sources/catalog/cloud-apps/zendesk/index.md | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index 8eb61c2241..84c1048903 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -13,7 +13,7 @@ id: 3hbak7a9 2. Choose Zendesk. -3. Give the Source a name and add any labels to help you organize and filter your sources. You can give the source any name, but Segment recommends a name that reflects the source itself, as this name auto-populates the schema name. For example, the source name `Zendesk` creates the schema `zendesk`. +3. Give the Source a name and add any labels to help you organize and filter your sources. You can give the source any name, but Segment recommends a name that reflects the source itself, as this name auto-populates the schema name. For example, the source name `Zendesk` creates the schema `zendesk`. **Note**: You can add multiple instances if you have multiple Zendesk accounts. That's why Segment allows you to customize the source's nickname and schema name. @@ -620,10 +620,6 @@ In your warehouse, each collection gets its own table. Find below a list of the via How the event was created. - - via_reference_id - - ### activities From 9684a7251955e63007cb11fd2fb01588f0ea097b Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Tue, 22 Mar 2022 08:38:20 -0400 Subject: [PATCH 30/51] [netlify-build] --- src/connections/sources/catalog/cloud-apps/zendesk/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index 84c1048903..1f0f26935c 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -1057,4 +1057,4 @@ In your warehouse, each collection gets its own table. Find below a list of the ## Adding Destinations -Currently only Warehouses are supported for object-cloud sources. +Currently only Warehouses are supported for object-cloud sources. \ No newline at end of file From a83773230793761f3b182ee76b7481004129f5a4 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Tue, 22 Mar 2022 09:41:11 -0400 Subject: [PATCH 31/51] DOC-452 Fixing HTML weirdness [netlify-build] --- .../catalog/cloud-apps/zendesk/index.md | 29 +++++++++++-------- 1 file changed, 17 insertions(+), 12 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index 1f0f26935c..247f0c427d 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -53,19 +53,19 @@ Collections are the groupings of resources Segment pulls from your source. | [users](#users) | object | Zendesk Support has three types of users: end-users (your customers), agents, and administrators. End-users request support through tickets. Agents work in Zendesk Support to solve tickets. Agents can be divided into multiple groups and can also belong to multiple groups. Agents don't have access to administrative configuration in Zendesk Support such as business rules or automation, but can configure their own macros and views. Administrators have all the abilities of agents, plus administrative abilities. | | [groups](#groups) | object | When support requests arrive in Zendesk, they can be assigned to a Group. Groups serve as the core element of ticket workflow; support agents are organized into Groups and tickets can be assigned to a Group only, or to an assigned agent within a Group. A ticket can never be assigned to an agent without also being assigned to a Group. | | [tickets](#tickets) | object | Tickets are the means through which your End-users (customers) communicate with Agents in Zendesk. **Note**: Segment pulls all tickets updated (or created) in the last year to start by default. If you need more, reach out to Segment support. Support can do a run to pull further back in history. | -| [ticket_fields](#ticketfields) | object | Customize fields on the ticket form. | +| [ticket_fields](#ticket_fields) | object | Customize fields on the ticket form. | | [activities](#activities) | object | The activity stream is a per agent event stream. It will give access to the most recent events that relate to the agent polling the API. | | [attachments](#activities) | object | This API is for attachments in tickets and forum posts in the Web portal. | | [organizations](#organizations) | object | Just as agents can be segmented into groups in Zendesk, your customers (end-users) can be segmented into organizations. | -| [ticket_events](#ticketevents) | events | Returns a stream of changes that occurred on tickets. Each event is tied to an update on a ticket and contains all the fields that were updated in that change. **Note**: Segment pulls one year of ticket events to start by default. If you need more, reach out to [Segment support](https://segment.com/help/contact/). Support can do a run to pull further back in history. | -| [ticket_metrics](#ticketmetrics) | object | All kinds of aggregate metrics about a ticket | -| [satisfaction_ratings](#satisfactionratings) | object | If you have enabled satisfaction ratings for your account, this end point allows you to quickly retrieve all ratings. | -| [ticket_comments](#ticketcomments) | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | -| [ticket_forms](#ticketforms) | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | -| [ticket_skips](#ticketskips) | object | A skip is a record of when an agent skips over a ticket without responding to the end user. | -| [organization_memberships](#organizationmemberships) | object | A membership links a user to an organization. Organizations can have many users. Users can be in many organizations if the account supports multiple organizations. You can use the API to list users in an organization, and reassign organization members. | -| [group_memberships](#groupmemberships) | object | A membership links an agent to a group. Groups can have many agents, as agents can be in many groups. You can use the API to list what agents are in which groups, and reassign group members. | -| [audit_logs](#auditlogs) | object | The audit log shows various changes in your instance of Zendesk since the account was created. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | +| [ticket_events](#ticket_events) | events | Returns a stream of changes that occurred on tickets. Each event is tied to an update on a ticket and contains all the fields that were updated in that change. **Note**: Segment pulls one year of ticket events to start by default. If you need more, reach out to [Segment support](https://segment.com/help/contact/). Support can do a run to pull further back in history. | +| [ticket_metrics](#ticket_metrics) | object | All kinds of aggregate metrics about a ticket | +| [satisfaction_ratings](#satisfaction_ratings) | object | If you have enabled satisfaction ratings for your account, this end point allows you to quickly retrieve all ratings. | +| [ticket_comments](#ticket_comments) | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | +| [ticket_forms](#ticket_forms) | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | +| [ticket_skips](#ticket_skips) | object | A skip is a record of when an agent skips over a ticket without responding to the end user. | +| [organization_memberships](#organization_memberships) | object | A membership links a user to an organization. Organizations can have many users. Users can be in many organizations if the account supports multiple organizations. You can use the API to list users in an organization, and reassign organization members. | +| [group_memberships](#group_memberships) | object | A membership links an agent to a group. Groups can have many agents, as agents can be in many groups. You can use the API to list what agents are in which groups, and reassign group members. | +| [audit_logs](#audit_logs) | object | The audit log shows various changes in your instance of Zendesk since the account was created. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | In your warehouse, each collection gets its own table. Find below a list of the properties Segment automatically fetches for each collection. @@ -439,6 +439,7 @@ In your warehouse, each collection gets its own table. Find below a list of the removable If this field is not a system basic field that must be present for all tickets on the account. + created_at The time the ticket field was created. @@ -538,6 +539,7 @@ In your warehouse, each collection gets its own table. Find below a list of the updated_at When this record last got updated. + assignee_updated_at When the assignee last updated the ticket. @@ -554,10 +556,11 @@ In your warehouse, each collection gets its own table. Find below a list of the When the ticket was initially assigned. - assigned_at + assigned_at When the ticket was last assigned. - solved_at + + solved_at When the ticket was solved. @@ -756,6 +759,7 @@ In your warehouse, each collection gets its own table. Find below a list of the id Automatically assigned when the organization is created. + url The API url of this rating. @@ -803,6 +807,7 @@ In your warehouse, each collection gets its own table. Find below a list of the id Automatically assigned when the comment is created. + ticket_event_id Automatically assigned when the comment is created. From 262d50e1f8a69e9e5e5327adc72ab1231c4742e1 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Tue, 22 Mar 2022 10:48:28 -0400 Subject: [PATCH 32/51] DOC-452 Making changes requested by PM [netlify-build] --- src/connections/sources/catalog/cloud-apps/zendesk/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index 247f0c427d..430f6ef44b 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -61,7 +61,7 @@ Collections are the groupings of resources Segment pulls from your source. | [ticket_metrics](#ticket_metrics) | object | All kinds of aggregate metrics about a ticket | | [satisfaction_ratings](#satisfaction_ratings) | object | If you have enabled satisfaction ratings for your account, this end point allows you to quickly retrieve all ratings. | | [ticket_comments](#ticket_comments) | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | -| [ticket_forms](#ticket_forms) | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | +| [ticket_forms](#ticket_forms) | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. | | [ticket_skips](#ticket_skips) | object | A skip is a record of when an agent skips over a ticket without responding to the end user. | | [organization_memberships](#organization_memberships) | object | A membership links a user to an organization. Organizations can have many users. Users can be in many organizations if the account supports multiple organizations. You can use the API to list users in an organization, and reassign organization members. | | [group_memberships](#group_memberships) | object | A membership links an agent to a group. Groups can have many agents, as agents can be in many groups. You can use the API to list what agents are in which groups, and reassign group members. | From f745d9ac17b0a6feb3554b3373039b9118e7adf5 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Tue, 22 Mar 2022 11:14:45 -0400 Subject: [PATCH 33/51] DOC-452 Fixing duplicate description [netlify-build] --- src/connections/sources/catalog/cloud-apps/zendesk/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index 430f6ef44b..a85975e611 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -61,7 +61,7 @@ Collections are the groupings of resources Segment pulls from your source. | [ticket_metrics](#ticket_metrics) | object | All kinds of aggregate metrics about a ticket | | [satisfaction_ratings](#satisfaction_ratings) | object | If you have enabled satisfaction ratings for your account, this end point allows you to quickly retrieve all ratings. | | [ticket_comments](#ticket_comments) | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | -| [ticket_forms](#ticket_forms) | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. | +| [ticket_forms](#ticket_forms) | object | Ticket forms allow an admin to define a subset of ticket fields for display to both agents and end users. | | [ticket_skips](#ticket_skips) | object | A skip is a record of when an agent skips over a ticket without responding to the end user. | | [organization_memberships](#organization_memberships) | object | A membership links a user to an organization. Organizations can have many users. Users can be in many organizations if the account supports multiple organizations. You can use the API to list users in an organization, and reassign organization members. | | [group_memberships](#group_memberships) | object | A membership links an agent to a group. Groups can have many agents, as agents can be in many groups. You can use the API to list what agents are in which groups, and reassign group members. | From f74634f4042780ebc4eff7e6e03460cc598acfe4 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 23 Mar 2022 08:38:15 -0400 Subject: [PATCH 34/51] Apply suggestions from code review [netlify-build] Co-authored-by: stayseesong <83784848+stayseesong@users.noreply.github.com> --- .../catalog/cloud-apps/zendesk/index.md | 52 +++++++++---------- 1 file changed, 26 insertions(+), 26 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index a85975e611..089e1cd761 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -9,17 +9,17 @@ id: 3hbak7a9 ## Getting Started -1. From your workspace's `sources` page, click `add source`. +1. Go to **Connections > Sources** and click **Add Source** in the Segment app. -2. Choose Zendesk. +2. Search for **Zendesk** in the Sources Catalog and click **Add Source**. 3. Give the Source a name and add any labels to help you organize and filter your sources. You can give the source any name, but Segment recommends a name that reflects the source itself, as this name auto-populates the schema name. For example, the source name `Zendesk` creates the schema `zendesk`. - **Note**: You can add multiple instances if you have multiple Zendesk accounts. That's why Segment allows you to customize the source's nickname and schema name. + * **Note**: You can add multiple instances if you have multiple Zendesk accounts. That's why Segment allows you to customize the source's nickname and schema name. 4. Enter your Zendesk subdomain. The subdomain you use to access your Zendesk portal (for example 'segment' for segment.zendesk.com) - **Note** If you enter `segment.zendesk.com` as a subdomain instead of just `segment`, Segment tries to access the host `segment.zendesk.com.zendesk.com` and you will get a credentials error. + * **Note:** If you enter `segment.zendesk.com` as a subdomain instead of just `segment`, Segment tries to access the host `segment.zendesk.com.zendesk.com` and you will get a credentials error. 5. Click **Authorize** to start Zendesk's OAuth process. Sign in and grant permissions, you'll be good to go. @@ -29,17 +29,17 @@ id: 3hbak7a9 ### Rate Limits -The Zendesk source uses both Zendesk's [Core API](https://developer.zendesk.com/api-reference/) and [Incremental Exports API](https://developer.zendesk.com/rest_api/docs/core/incremental_export). The source's requests to the Incremental API do not count towards your Zendesk account's rate limits, but requests to the Core API do. By default, Segment caps requests to Zendesk's Core API to a rate of 200 requests per minute to avoid triggering [Zendesk's Rate Limits](https://developer.zendesk.com/api-reference/ticketing/account-configuration/usage_limits/). If you'd like to increase or decrease the request rate for your source, [please reach out](https://segment.com/help/contact/). Support for this in the UI is in the works. +The Zendesk source uses both Zendesk's [Core API](https://developer.zendesk.com/api-reference/){:target="_blank"} and [Incremental Exports API](https://developer.zendesk.com/rest_api/docs/core/incremental_export){:target="_blank"}. The source's requests to the Incremental API don't count towards your Zendesk account's rate limits, but requests to the Core API do. By default, Segment caps requests to Zendesk's Core API to a rate of 200 requests per minute to avoid triggering [Zendesk's Rate Limits](https://developer.zendesk.com/api-reference/ticketing/account-configuration/usage_limits/){:target="_blank"}. If you'd like to increase or decrease the request rate for your source, [please reach out](https://segment.com/help/contact/). Support for this in the UI is in the works. ## Components ### Sync -The Zendesk source is built with a sync component, which means Segment makes requests to their API on your behalf on a three hour interval to pull the latest data into Segment. In the initial sync, Segment grabs all the Zendesk objects (and their corresponding properties) according to the Collections Table below. The objects will be written into a separate schema, corresponding to the source instance's schema name you designated upon creation (like `zendesk_prod.users`). +The Zendesk source is built with a sync component, which means Segment makes requests to their API on your behalf on a three hour interval to pull the latest data into Segment. In the initial sync, Segment grabs all the Zendesk objects (and their corresponding properties) according to the Collections Table below. The objects are written into a separate schema, corresponding to the source instance's schema name you designated upon creation (like `zendesk_prod.users`). -The sync component uses an upsert API, so the data in your warehouse loaded using sync will reflect the latest state of the corresponding resource in Zendesk. For example, if `ticket_status` goes from `open` to `closed` between syncs, on its next sync that tickets status will be `closed`. +The sync component uses an upsert API, so the data in your warehouse loaded using sync reflects the latest state of the corresponding resource in Zendesk. For example, if `ticket_status` goes from `open` to `closed` between syncs, on its next sync that tickets status is `closed`. -The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources will sync with Segment every three hours. Depending on your Warehouses plan, Segment pushes the Source data to your warehouse on the interval associated with your billing plan. +The source syncs and warehouse syncs are independent processes. Source runs pull your data into the Segment Hub, and warehouse runs flush that data to your warehouse. Sources sync with Segment every three hours. Depending on your Warehouses plan, Segment pushes the Source data to your warehouse on the interval associated with your billing plan. At the moment, Segment doesn't support filtering which objects or properties get synced. If you're interested in this feature, [please reach out](https://segment.com/help/contact/). @@ -589,15 +589,15 @@ In your warehouse, each collection gets its own table. Find below a list of the ticket_id - ID of the associated ticket. + The ID of the associated ticket. timestamp - Time when the ticket was updated. + The time when the ticket was updated. updater_id - ID of the user who updated the ticket. + The ID of the user who updated the ticket. ticket_event_via @@ -605,11 +605,11 @@ In your warehouse, each collection gets its own table. Find below a list of the context_client - Refers to the "client" used to submit this ticket change (for example, browser name and type). + This refers to the "client" used to submit this ticket change (for example, browser name and type). context_location - Plain text name of where the request was made, if available (for example, country, city). + The plain text name of where the request was made, if available (for example, country, city). context_latitude @@ -717,7 +717,7 @@ In your warehouse, each collection gets its own table. Find below a list of the details - Any details about the organization, such as the address. + This includes any details about the organization, such as the address. notes @@ -861,7 +861,7 @@ In your warehouse, each collection gets its own table. Find below a list of the end_user_visible - Shows if the form is visible to the end user. + This shows if the form is visible to the end user. name @@ -869,11 +869,11 @@ In your warehouse, each collection gets its own table. Find below a list of the restricted_brand_ids - IDs of all brands that this ticket form is restricted to. + The IDs of all brands that this ticket form is restricted to. ticket_field_ids - IDs of all ticket fields which are in this ticket form. + The IDs of all ticket fields which are in this ticket form. updated_at @@ -889,11 +889,11 @@ In your warehouse, each collection gets its own table. Find below a list of the display_name - The name of the form that is displayed to the end user. + The name of the form that displays to the end user. in_all_brands - Shows if the form is available for use in all brands on this account. + This shows if the form is available for use in all brands on this account. position @@ -909,7 +909,7 @@ In your warehouse, each collection gets its own table. Find below a list of the default - Shows if this form is the default form for this account. + This shows if this form is the default form for this account. @@ -925,19 +925,19 @@ In your warehouse, each collection gets its own table. Find below a list of the user_id - ID of the skipping agent. + The ID of the skipping agent. reason - Reason for skipping the ticket. + The reason for skipping the ticket. created_at - Time the skip was created. + The time the skip was created. updated_at - Time the skip was last updated. + The time the skip was last updated. @@ -949,7 +949,7 @@ In your warehouse, each collection gets its own table. Find below a list of the id - Automatically assigned when creating groups. + This is automatically assigned when creating groups. url @@ -961,7 +961,7 @@ In your warehouse, each collection gets its own table. Find below a list of the organization_id - the ID of the organization associated with this user. + The ID of the organization associated with this user. created_at From 2f7709beadad63656c63820abdebd17f7cdd760f Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 23 Mar 2022 10:41:35 -0400 Subject: [PATCH 35/51] DOC-452 HTML tables -> MD tables (1/2) --- .../catalog/cloud-apps/zendesk/index.md | 765 ++++-------------- 1 file changed, 161 insertions(+), 604 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index 089e1cd761..a36271561c 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -74,624 +74,181 @@ In your warehouse, each collection gets its own table. Find below a list of the > The list in this document includes the standard properties only, but doesn't include _your_ custom fields. (Don't worry, they'll be there in your warehouse.) ### groups - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
id Automatically assigned when creating groups.
url The API url of this group.
deleted Deleted groups get marked as such.
name The name of the group.
created_at The time the group was created.
updated_at The time of the last update of the group.
received_at This timestamp is added to incoming messages as soon as they hit Segment API.
+ +| Property | Description | +| ----------- | -------------------------------------------- | +| id | Automatically assigned when creating groups. | +| url | The API URL of this group. | +| deleted | Deleted groups get marked as such. | +| name | The name of the group. | +| created_at | The date and time the group was created. | +| updated_at | The date and time of the last update of the group. | +| received_at | This timestamp is added to incoming messages as soon as they hit Segment API. | ### users - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
id Automatically assigned when the user is created.
url Segment sets the "url" field users see in their Warehouse to equal the "id" from Zendesk, rather than the "url" field.
name The name of the user.
email The primary email address of this user..
time_zone The time-zone of this user.
phone The primary phone number of this user.
locale_id The language identifier for this user.
locale The locale for this user.
organization_id The ID of the organization this user is associated with.
role The role of the user. Possible values: "end-user", "agent", "admin".
verified The user's primary identity is verified or not.
external_id A unique identifier from another system. The API treats the ID as case insensitive. Example: ian1 and Ian1 are the same user.
alias An alias displayed to end users.
active false if the user has been deleted.
shared If the user is shared from a different Zendesk Support instance. Ticket sharing accounts only.
shared_agent If the user is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only.
last_login_at The last time the user signed in to Zendesk Support.
two_factor_auth_enabled If two factor authentication is enabled.
signature The user's signature. Only agents and admins can have signatures.
details Any details you want to store about the user, such as an address.
notes Any notes you want to store about the user.
custom_role_id A custom role if the user is an agent on the Enterprise plan.
moderator Designates whether the user has forum moderation capabilities.
ticket_restriction Specifies which tickets the user has access to. Possible values are: "organization", "groups", "assigned", "requested", null.
only_private_comments true if the user can only create private comments.
restricted_agent If the agent has any restrictions; false for admins and unrestricted agents, true for other agents.
suspended If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal.
chat_only Whether or not the user is a chat-only agent.
created_at The time the user was created.
suspended The time of the last update of the user.
received_at This timestamp is added to incoming messages as soon as they hit Segment API.
+ +| Property | Description | +| --------------- | ----------------------------------------------------------------- | +| id | Automatically assigned when the user is created. | +| url | Segment sets the “url” field users see in their Warehouse to equal the “id” from Zendesk, rather than the “url” field. | +| name | The name of the user. | +| email | The primary email address of the user. | +| time_zone | The time-zone of this user. | +| phone | The primary phone number of this user. | +| locale_id | The language identifier of this user. | +| locale | The locale for this user. | +| organization_id | The ID of the organization that this user is associated with. | +| role | The role of the user. Possible values: "end-user", "agent", "admin". | +| verified | The user's primary identity is verified or not. | +| external_id | A unique identifier from another system. The API treats the ID as case insensitive. Example: ian1 and Ian1 are the same user. | +| alias | An alias displayed to end users. | +| active | This is set to false if the user has been deleted. | +| shared | If the user is a shared agent from different Zendesk Support instance. Ticket sharing accounts only. | +| last_login_at | The last time the user signed in to Zendesk Support. | +| two_factor_auth_enabled | If two factor authentication is enabled. | +| signature | The user's signature. Only agents and admins can have signatures. | +| details | Any details you want to store about the user, such as an address. | +| notes | Any notes you want to store about the user. | +| custom_role_id | A custom role if the user is an agent on the Enterprise plan. | +| moderator | Designates whether the user has forum moderation capabilities. | +| ticket_restriction | Specifies which tickets the user has access to. Possible values are: “organization”, “groups”, “assigned”, “requested”, null. | +| only_private_comments | This is set to true if the user can only create private comments. | +| restricted_agent | If the agent has any restrictions: This is set to false for admins and unrestricted agents, true for other agents. | +| suspended | If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal. | +| chat_only | Whether or not the user is a chat-only agent. | +| updated_at | The date and time of the user's last update. | +| received_at | This timestamp is added to incoming messages as soon as they hit Segment API. | ### tickets - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
id Automatically assigned when the ticket is created.
url The API url of this ticket.
external_id An ID you can use to link Zendesk Support tickets to local records.
type The type of this ticket. Possible values: "problem", "incident", "question" or "task".
subject The value of the subject field for this ticket.
raw_subject The dynamic content placeholder, if present, or the "subject" value, if not.
description The first comment on the ticket.
priority The urgency with which the ticket should be addressed. Possible values: "urgent", "high", "normal", "low".
status The state of the ticket. Possible values: "new", "open", "pending", "hold", "solved", "closed".
recipient The original recipient e-mail address of the ticket.
requester_id The user who requested this ticket.
submitter_id The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket.
assignee_id The agent currently assigned to the ticket.
organization_id The organization of the requester. You can only specify the ID of an organization associated with the requester.
group_id The group this ticket is assigned to.
collaborator_ids The IDs of users currently cc'ed on the ticket.
forum_topic_id The topic this ticket originated from, if any.
problem_id For tickets of type "incident", the ID of the problem the incident is linked to.
has_incidents Is true of this ticket has been marked as a problem, false otherwise.
due_at If this is a ticket of type "task" it has a due date. Due date format uses ISO 8601 format.
tags The array of tags applied to this ticket.
sharing_agreement_ids The IDs of the sharing agreements used for this ticket.
created_at When this record was created.
updated_at When this record last got updated.
received_at This timestamp is added to incoming messages as soon as they hit Segment API.
ticket_form_idThe ID of the ticket form to render for the ticket (Enterprise only).
+ +| Property | Description | +| --------------- | ----------------------------------------------------------------- | +| id | Automatically assigned when the ticket is created. | +| url | The API URL of this ticket. | +| external_id | An ID you can use to link Zendesk Support tickets to local records. | +| type | The type of this ticket. Possible values: “problem”, “incident”, “question” or “task”. | +| subject | The value of the subject field for this ticket. | +| raw_subject | The dynamic content placeholder, if present, or the "subject" value, if not. | +| description | The first comment on the ticket. | +| priority | The urgency with which the ticket should be addressed. Possible values: “urgent”, “high”, “normal”, “low”. | +| status | The state of the ticket. Possible values: “new”, “open”, “pending”, “hold”, “solved”, “closed”. | +| recipient | The original recipient e-mail address of the ticket. | +| requester_id | The user who requested this ticket. | +| submitter_id | The user who submitted the ticket. The submitter always becomes the author of the first comment on the ticket. | +| assignee_id | The agent currently assigned to the ticket. | +| organization_id | The organization of the requester. You can only specify the ID of an organization associated with the requester. | +| group_id | The group this ticket is assigned to. | +| collaborator_ids | The IDs of users currently cc’ed on the ticket. | +| forum_topic_id | The topic this ticket originated from, if any. | +| problem_id | For tickets of type "incident," The ID of the problem the incident is linked to. | +| has_incidents | Is true of this ticket has been marked as a problem, false otherwise. | +| due_at | If this is a ticket of type "task" it has a due date. Due date format uses ISO 8601 format. | +| tags | The array of tags applied to this ticket. | +| sharing_agreement_ids | The IDs of sharing agreements used for this ticket. | +| created_at | The date and time this record was created. | +| updated_at | The date and time this record was last updated. | +| received_at | This timestamp is added to incoming messages as soon as they hit Segment API. | +| ticket_form_id | The ID of the ticket form to render the ticket (Enterprise only). | ### ticket_fields - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
id Automatically assigned upon creation.
url The URL for this resource.
type The type of the ticket field: "checkbox", "date", "decimal", "integer", "regexp", "tagger", "text", or "textarea". *Type is not editable once created.
slug The title of the ticket field separated by _.
title The title of the ticket field.
raw_title The dynamic content placeholder, if present, or the "title" value, if not.
description The description of the purpose of this ticket field, shown to users.
raw_description The dynamic content placeholder, if present, or the "description" value, if not.
position A relative position for the ticket fields that determines the order of ticket fields on a ticket. Note that positions 0 to 7 are reserved for system fields.
active Whether this field is available.
required If it's required for this field to have a value when updated by agents.
collapsed_for_agents If this field should be shown to agents by default or be hidden alongside infrequently used fields. Classic interface only.
regexp_for_validation Regular expression field only. The validation pattern for a field value to be deemed valid.
title_in_portal The title of the ticket field when shown to end users.
raw_title_in_portal The dynamic content placeholder, if present, or the "title_in_portal" value, if not.
visible_in_portal Whether this field is available to end users.
editable_in_portal Whether this field is editable by end users.
required_in_portal If it's required for this field to have a value when updated by end users.
tag A tag value to set for checkbox fields when checked.
removable If this field is not a system basic field that must be present for all tickets on the account.
created_at The time the ticket field was created.
updated_at The time of the last update of the ticket field.
received_at This timestamp is added to incoming messages as soon as they hit Segment API.
+ +| Property | Description | +| --------------- | ----------------------------------------------------------------- | +| id | Automatically assigned upon creation. | +| url | The URL for this resource. | +| type | The type of the ticket field: “checkbox”, “date”, “decimal”, “integer”, “regexp”, “tagger”, “text”, or “textarea”. _*Type is not editable once created._ | +| slug | The title of the ticket field separated by _. | +| title | The title of the ticket field. | +| raw_title | The dynamic content placeholder, if present, or the "title" value, if not. | +| description | The description of the purpose of this ticket field shown to users. | +| raw_description | The dynamic content placeholder, if present, or the “description” value, if not. | +| position | A relative position for the ticket fields that determines the order of ticket fields on a ticket. Note that positions 0 to 7 are reserved for system fields. | +| active | Whether this field is available. | +| required | If it’s required for this field to have a value when updated by agents.| +| collapsed_for_agents | If this field should be shown to agents by default or be hidden alongside infrequently used fields. Classic interface only. | +| regexp_for_validation | Regular expression field only. The validation pattern for a field value to be deemed valid. | +| title_in_portal | The title of the ticket field when shown to end users. | +| raw_title_in_portal | The dynamic content placeholder, if present, or the “title_in_portal” value, if not. | +| visible_in_portal | Whether this field is available to end users. | +| editable_in_portal | Whether this field is editable by end users. | +| required_in_portal | If it’s required for this field to have a value when updated by end users. | +| tag | A tag value to set for checkbox fields when checked. | +| removable | If this field is not a system basic field that must be present for all tickets on the account. | +| created_at | The date and time the ticket field was created. | +| updated_at | The date and time of the last update of the ticket field. | +| received_at | This timestamp is added to incoming messages as soon as they hit Segment API. | ### ticket_metrics - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
id Automatically assigned.
ticket_id ID of the associated ticket.
group_stations Number of groups this ticket passed through.
assignee_stations Number of assignees this ticket had.
reopens Total number of times the ticket was reopened.
replies Total number of times ticket was replied to.
reply_time_in_minutes_calendar Number of minutes to the first reply outside of business hours.
reply_time_in_minutes_business Number of minutes to the first reply during business hours.
first_resolution_time_in_minutes_calendar Number of minutes to the first resolution time outside of business hours.
first_resolution_time_in_minutes_business Number of minutes to the first resolution time during business hours.
full_resolution_time_in_minutes_calendar Number of minutes to the full resolution outside of business hours.
full_resolution_time_in_minutes_business Number of minutes to the full resolution during business hours.
agent_wait_time_in_minutes_calendar Number of minutes the agent spent waiting outside of business hours.
agent_wait_time_in_minutes_business Number of minutes the agent spent waiting during business hours.
requester_wait_time_in_minutes_calendar Number of minutes the requester spent waiting outside of business hours.
requester_wait_time_in_minutes_business Number of minutes the requester spent waiting during business hours.
on_hold_time_in_minutes_calendar Number of minutes the ticket was on hold outside of business hours.
on_hold_time_in_minutes_business Number of minutes the ticket was on hold during business hours.
created_at When this record was created.
updated_at When this record last got updated.
assignee_updated_at When the assignee last updated the ticket.
requester_updated_at When the requester last updated the ticket.
status_updated_at When the status was last updated.
initially_assigned_at When the ticket was initially assigned.
assigned_at When the ticket was last assigned.
solved_at When the ticket was solved.
latest_comment_added_at When the latest comment was added.
received_at This timestamp is added to incoming messages as soon as they hit Segment API.
+ +| Property | Description | +| --------------- | ----------------------------------------------------------------- | +| id | Automatically assigned. | +| ticket_id | ID of the associated ticket. | +| group_stations | Number of groups this ticket passed through. | +| assignee_stations | Number of assignees this ticket had. | +| reopens | Total number of times the ticket was reopened. | +| replies | Total number of times ticket was replied to. | +| reply_time_in_minutes_calendar | Number of minutes to the first reply outside of business hours. | +| reply_time_in_minutes_business | Number of minutes to the first reply during business hours. | +| first_resolution_time_in_minutes_calendar | Number of minutes to the first resolution time outside of business hours. | +| first_resolution_time_in_minutes_business | Number of minutes to the first resolution time during business hours. | +| full_resolution_time_in_minutes_calendar | Number of minutes to the full resolution outside of business hours. | +| full_resolution_time_in_minutes_business | Number of minutes to the full resolution during business hours. | +| agent_wait_time_in_minutes_calendar | Number of minutes the agent spent waiting outside of business hours. | +| agent_wait_time_in_minutes_business | Number of minutes the agent spent waiting during business hours. | +| requester_wait_time_in_minutes_calendar | Number of minutes the requester spent waiting outside of business hours. | +| requester_wait_time_in_minutes_business | Number of minutes the requester spent waiting during business hours. | +| on_hold_time_in_minutes_calendar | Number of minutes the ticket was on hold outside of business hours. | +| on_hold_time_in_minutes_business | Number of minutes the ticket was on hold during business hours. | +| created_at | The date and time this record was created. | +| updated_at | The date and time this record was last updated. | +| assignee_updated_at | The date and time the assignee last updated the ticket. | +| requester_updated_at | The date and time the requester last updated the ticket. | +| status_updated_at | The date and time the status was last updated. | +| initially_assigned_at | The date and time the ticket was initially assigned. | +| assigned_at | The date and time the ticket was last assigned. | +| latest_comment_added_at | The date and time the latest comment was added. | +| received_ at | This timestamp is added to incoming messages as soon as they hit Segment API. | ### ticket_events - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
id Automatically assigned.
ticket_event_id Automatically assigned when the ticket is updated.
ticket_id The ID of the associated ticket.
timestamp The time when the ticket was updated.
updater_id The ID of the user who updated the ticket.
ticket_event_via How the event was created.
context_client This refers to the "client" used to submit this ticket change (for example, browser name and type).
context_location The plain text name of where the request was made, if available (for example, country, city).
context_latitude Latitude of the location where the ticket was changed.
context_longitude Longitude of the location where the ticket was changed.
via How the event was created.
+ +| Property | Description | +| --------------- | ----------------------------------------------------------------- | +| id | Automatically assigned. | +| ticket_event_id | Automatically assigned when the ticket is updated. | +| ticket_id | The ID of the associated ticket. | +| timestamp | The time when the ticket was updated. | +| updater_id | The ID of the user who updated the ticket. | +| ticket_event_via | How the event was created. | +| context_client | This refers to the “client” used to submit this ticket change (for example, browser name and type). | +| context_location | The plain text name of where the request was made, if available (for example, country, city). | +| context_latitude | Latitude of the location where the ticket was changed. | +| context_longitude | Longitude of the location where the ticket was changed. | +| via | How the event was created. | + ### activities - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
id Automatically assigned upon creation.
url The API url of this activity.
verb The type of activity. Can be tickets.assignment, tickets.comment, or tickets.priority_increase.
title Description of this activity.
created_at When this record was created.
updated_at When this record last got updated.
+ +| Property | Description | +| --------------- | ----------------------------------------------------------------- | +| id | Automatically assigned upon creation. | +| url | The API URL of this activity. | +| verb | The type of activity. Can be "tickets.assignment," "tickets.comment," or "tickets.priority_increase." | +| title | Description of this activity. | +| created_at | The date and time this record was created. | +| updated_at | The date and time this record was last updated. | ### attachments - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
id Automatically assigned upon creation.
file_name The name of the image file.
content_url A full URL where the attachment image file can be downloaded.
content_type The content type of the image. Example value: image/png.
inline If true, the attachment is excluded from the attachment list and the attachment's URL can be referenced within the comment of a ticket. Default is false.
size The size of the image file in bytes.
received_at This timestamp is added to incoming messages as soon as they hit Segment API.
+ +| Property | Description | +| --------------- | ----------------------------------------------------------------- | +| id | Automatically assigned upon creation. | +| file_name | The name of the image file. | +| content_url | A full URL where the attachment image file can be downloaded. | +| content_type | The content type of the image. Example value: image/png. | +| inline | If true, the attachment is excluded from the attachment list and the attachment’s URL can be referenced within the comment of a ticket. Default is false. | +| size | The size of the image file in bytes. | +| recieved_at | This timestamp is added to incoming messages as soon as they hit Segment API. | ### organizations From 3ca095c8a8b63a4c7bf43a84bd82f5e4b3ad9c7f Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 23 Mar 2022 10:45:26 -0400 Subject: [PATCH 36/51] DOC-452 Fixing small spelling error --- src/connections/sources/catalog/cloud-apps/zendesk/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index a36271561c..03de57185c 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -248,7 +248,7 @@ In your warehouse, each collection gets its own table. Find below a list of the | content_type | The content type of the image. Example value: image/png. | | inline | If true, the attachment is excluded from the attachment list and the attachment’s URL can be referenced within the comment of a ticket. Default is false. | | size | The size of the image file in bytes. | -| recieved_at | This timestamp is added to incoming messages as soon as they hit Segment API. | +| received_at | This timestamp is added to incoming messages as soon as they hit Segment API. | ### organizations
From afaf692de59510b748235ab8a07866523153bfb5 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Wed, 23 Mar 2022 16:30:11 -0400 Subject: [PATCH 37/51] DOC-452 HTML -> MD tables (2/2) [netlify-build] --- .../catalog/cloud-apps/zendesk/index.md | 441 ++++-------------- 1 file changed, 87 insertions(+), 354 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index 03de57185c..a1bdd31c99 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -251,372 +251,105 @@ In your warehouse, each collection gets its own table. Find below a list of the | received_at | This timestamp is added to incoming messages as soon as they hit Segment API. | ### organizations -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
id Automatically assigned when the organization is created.
external_id A unique external ID to associate organizations to an external record.
url The API url of this organization.
name A unique name for the organization.
details This includes any details about the organization, such as the address.
notes Any notes you have about the organization.
group_id New tickets from users in this organization are automatically put in this group.
shared_tickets End users in this organization are able to see each other's tickets.
shared_comments End users in this organization are able to see each other's comments on tickets.
created_at The time the organization was created.
updated_at The time of the last update of the organization.
received_at This timestamp is added to incoming messages as soon as they hit Segment API.
- -### satisfaction_ratings - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
id Automatically assigned when the organization is created.
url The API url of this rating.
assignee_id The ID of agent assigned to at the time of rating.
group_id The ID of group assigned to at the time of rating.
requester_id The ID of ticket requester submitting the rating.
ticket_id The ID of ticket being rated.
score The rating: "offered", "unoffered", "good" or "bad".
created_at The time the satisfaction rating got created.
updated_at The time the satisfaction rating got updated.
received_at This timestamp is added to incoming messages as soon as they hit Segment API.
+ +| Property | Description | +| --------------- | ----------------------------------------------------------------- | +| id | Automatically assigned when the organization is created. | +| external_id | A unique external ID to associate organizations to an external record. | +| url | The API URL of this organization. | +| name | A unique name for the organization. | +| details | This includes any details about the organization, such as the address. | +| notes | Any notes you have about the organization. | +| group_id | New tickets from users in this organization are automatically put in this group. | +| shared_tickets | End users in this organization are able to see each other’s tickets. | +| shared_comments | End users in this organization are able to see each other’s comments on tickets. | +| created_at | The date and time that the organization was created. | +| updated_at | The date and time that the organization was last updated. | +| received_at | This timestamp is added to incoming messages as soon as they hit Segment API. | ### ticket_comments - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
id Automatically assigned when the comment is created.
ticket_event_id Automatically assigned when the comment is created.
ticket_id The ID of ticket being commented.
type Comment or VoiceComment. The JSON object for voice comments is different.
body The comment string.
public true if a public comment; false if an internal note. The initial value set on ticket creation persists for any additional comment unless you change it.
author_id The ID of the comment author.
via How the comment was created.
created_at The time the comment was created.
received_at This timestamp is added to incoming messages as soon as they hit Segment API.
+ +| Property | Description | +| --------------- | ----------------------------------------------------------------- | +| id | Automatically assigned when the comment is created. | +| ticket_event_id | Automatically assigned when the comment is created. | +| ticket_id | The ID of the ticket being commented. | +| type | Comment or VoiceComment. The JSON object for voice comments is different. | +| body | The comment string. | +| public | true if a public comment; false if an internal note. The initial value set on ticket creation persists for any additional comment unless you change it. | +| author_id | The ID of the comment author. | +| via | How the comment was created. | +| created_at | The time the comment was created. | +| received_at | This timestamp is added to incoming messages as soon as they hit Segment API. | ### ticket_forms - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
idAutomatically assigned when creating groups.
activeShows if the form is set as active.
end_user_visibleThis shows if the form is visible to the end user.
nameThe name of the form.
restricted_brand_idsThe IDs of all brands that this ticket form is restricted to.
ticket_field_idsThe IDs of all ticket fields which are in this ticket form.
updated_atThe time of the last update of the ticket form.
url The API url of this ticket.
created_atThe time the ticket form was created.
display_nameThe name of the form that displays to the end user.
in_all_brandsThis shows if the form is available for use in all brands on this account.
positionThe position of this form among other forms in the account (for example, dropdown)
raw_display_nameThe dynamic content placeholder (if available,) or the "display_name" value, if the dynamic content placeholder is unavailable.
raw_nameThe dynamic content placeholder (if available,) or the "name" value, if the dynamic content placeholder is unavailable.
defaultThis shows if this form is the default form for this account.
+ +| Property | Description | +| --------------- | ----------------------------------------------------------------- | +| id | Automatically assigned when the ticket form is created. | +| active | If set to true, this shows that the form is active. | +| end_user_visible | If set to true, this shows that the form is visible to end users.| +| name | The name of the form. | +| restricted_brand_ids | The IDs of all brands that this ticket form is restricted to. | +| ticket_field_ids | The IDs of all ticket fields which are in this ticket form. | +| updated_at | The date and time the ticket form was last updated. | +| url | The URL of the ticket form. | +| created_at | The date and time the ticket form was created. | +| display_name | The name of the form that displays to the end user. | +| in_all_brands | This shows if the form is available for use in all brands on this account. | +| position | The position of this form among other forms in the account (for example, dropdown) | +| raw_display_name | The dynamic content placeholder (if available,) or the “display_name” value, if the dynamic content placeholder is unavailable. | +| raw_name | The dynamic content placeholder (if available,) or the “name” value, if the dynamic content placeholder is unavailable. | +| default | If set to true, this shows that the form is the default form for this account. | ### ticket_skips - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
idAutomatically assigned when creating groups.
user_idThe ID of the skipping agent.
reasonThe reason for skipping the ticket.
created_atThe time the skip was created.
updated_atThe time the skip was last updated.
+ +| Property | Description | +| --------------- | ----------------------------------------------------------------- | +| id | Automatically assigned upon ticket skip creation. | +| user_id | The ID of the skipping agent. | +| reason | The reason for skipping the ticket. | +| created_at | The date and time the skip was created. | +| updated_at | The date and time the skip was last updated. | ### organization_memberships - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
idThis is automatically assigned when creating groups.
url The API url of this ticket.
user_idThe ID of the user who has this organization membership.
organization_idThe ID of the organization associated with this user.
created_atWhen this record was created.
updated_atWhen this record was last updated.
organization_nameThe name of the organization associated with this user.
+ +| Property | Description | +| --------------- | ----------------------------------------------------------------- | +| id | Automatically assigned when creating organizations. | +| url | The URL of this organization. | +| user_id | The ID of the user associated with this organization. | +| organization_id | The ID of the organization associated with the selected user | +| created_at | The date and time this record was created. | +| updated_at | The date and time this record was last updated. | +| organization_name | The name of the organization associated with the selected user. | ### group_memberships - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
id Automatically assigned when creating groups.
url The API url of this group.
created_at The time the group was created.
group_id The ID of the group assigned to at the time of rating.
updated_at The time of the last update of the group.
user_id The ID of an agent.
+ +| Property | Description | +| --------------- | ----------------------------------------------------------------- | +| id | Automatically assigned when creating groups. | +| url | The API URL of this group. | +| created_at | The date and time the group was created. | +| group_id | The ID of the group. | +| updated_at | The date and time the group was last updated. | +| user_id | The ID of an agent. | ### audit_logs - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
PropertyDescription
idAutomatically assigned when creating groups.
url The API url of this ticket.
created_atThe time the audit got created.
actor_idThe ID of the user creating the ticket
source_idThe ID of the item being audited.
source_typeThe item type being audited.
source_labelThe name of the item being audited.
actionThe action a user performed. Either "login", "create", "update", or "destroy".
change_descriptionThe description of the change that occurred.
ip_addressThe IP address of the user performing the audit.
action_labelA localized string of action field.
+ +| Property | Description | +| --------------- | ----------------------------------------------------------------- | +| id | Automatically assigned when creating audit logs. | +| url | The URL to access the audit log. | +| created_at | The date and time that the audit was created. | +| actor_id | The ID of the user creating the ticket. | +| source_id | The ID of the item being audited. | +| source_type | The item type being audited. | +| source_label | The name of the item being audited. | +| action | The action a user performed. Either “login”, “create”, “update”, or “destroy”. | +| change_description | The description of the change that occurred. | +| ip_address | The IP address of the user performing the audit. | +| action_label | A localized string of action field. | ## Adding Destinations Currently only Warehouses are supported for object-cloud sources. \ No newline at end of file From b7dd243ec0db23c6994fac5ee65610dc2c66db0e Mon Sep 17 00:00:00 2001 From: umangmoe Date: Fri, 25 Mar 2022 15:21:53 +0530 Subject: [PATCH 38/51] MoEngage SDK version 12, 8 document update --- .../destinations/catalog/moengage/index.md | 83 +++++++++++++------ 1 file changed, 59 insertions(+), 24 deletions(-) diff --git a/src/connections/destinations/catalog/moengage/index.md b/src/connections/destinations/catalog/moengage/index.md index fffeee9f3d..27cfaec571 100644 --- a/src/connections/destinations/catalog/moengage/index.md +++ b/src/connections/destinations/catalog/moengage/index.md @@ -11,7 +11,7 @@ The Segment-MoEngage Integration is a bundled integration, meaning it requires t ## Setup MoEngage in your Segment Workspace: To setup MoEngage do the following : - 1. First get your key([AppID](http://app.moengage.com/v3/#/settings/0/0)) from the MoEngage dashboard. + 1. First get your key(AppID) from the MoEngage dashboard, `Dashboard --> Settings --> App --> General`. 2. Go to your **Segment workspace**, go to **Destinations** and select **MoEngage**. 3. Enable the MoEngage Destination. 4. Go to the MoEngage Settings and enter the MoEngage AppID, obtained in **Step1**. @@ -43,14 +43,22 @@ To get started with MoEngage on iOS, first integrate your app with the [MoEngage ### Configure the Segment SDK: -Now head to the App Delegate file, and setup the Segment SDK by adding `SEGMoEngageIntegrationFactory` instance to the `SEGAnalyticsConfiguration` as shown below: +Now head to the App Delegate file, and setup the Segment SDK by +1. Importing `SEGMoEngageIntegrationFactory.h` and `SEGMoEngageInitializer.h`. +2. Initialize `MOSDKConfig` object and call `initializeDefaultInstance:` method of `SEGMoEngageInitializer`. +3. Initialize `SEGMoEngageIntegrationFactory` instance to the `SEGAnalyticsConfiguration` as shown below: ```objc - #import // This line is key for MoEngage integration + #import + #import #import - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions { + //Initialize SDKConfig object and call initializeDefaultInstance: method of SEGMoEngageInitializer + MOSDKConfig* sdkConfig = [[MOSDKConfig alloc] initWithAppID:@"YOUR APP ID"]; + [SEGMoEngageInitializer initializeDefaultInstance:sdkConfig]; + // Add your configuration key from Segment SEGAnalyticsConfiguration *config = [SEGAnalyticsConfiguration configurationWithWriteKey:@"configuration key"]; @@ -100,17 +108,17 @@ To differentiate between those, use one of the method below: ```objc //For new Install call following - [[MoEngage sharedInstance] appStatus:INSTALL]; + [[MoEngage sharedInstance] appStatus:AppStatusInstall]; //For an app update call following - [[MoEngage sharedInstance] appStatus:UPDATE]; + [[MoEngage sharedInstance] appStatus:AppStatusUpdate]; ``` -Read more on [install/update differentiation](https://docs.moengage.com/docs/installupdate-differentiation). +Read more on [install/update differentiation](https://developers.moengage.com/hc/en-us/articles/4403910297620). ### Set the data center -By default, the data center setting in the SDK is set to `DATA_CENTER_01`. Follow the steps in the [MoEngage - Data Redirection](https://docs.moengage.com/docs/data-redirection) to update the data center value. If not set correctly, several features of the MoEngage SDK will not function. +By default, the data center setting in the SDK is set to `data_center_01`. Follow the steps in the [MoEngage - Data Redirection](https://developers.moengage.com/hc/en-us/articles/4403910162452-Data-Center) to update the data center value. If not set correctly, several features of the MoEngage SDK will not function. ### Using features provided in the MoEngage SDK @@ -139,19 +147,19 @@ Push Notifications are a great way to keep your users engaged and informed about ``` **MoEngage Push Implementation:** -For information about the MoEngage push implementation, see [**Push Notifications**](https://docs.moengage.com/docs/push-notifications) in the MoEngage documentation. +For information about the MoEngage push implementation, see [**Push Notifications**](https://developers.moengage.com/hc/en-us/articles/4403943988756) in the MoEngage documentation. #### In-app messaging -In-App Messages are custom views which you can send to a set of users to show custom messages, give new offers, or direct to a specific page. For more information about In-app messaging, see [MoEngage - In-App NATIV](https://docs.moengage.com/docs/in-app-nativ) +In-App Messages are custom views which you can send to a set of users to show custom messages, give new offers, or direct to a specific page. For more information about In-app messaging, see [MoEngage - In-App NATIV](https://developers.moengage.com/hc/en-us/articles/4404155127828-In-App-Nativ) #### Cards -Create targeted or automated App Inbox/NewsFeed messages that can be grouped into various categories, and target your users with different updates or offers that can stay in the Inbox/Feed over a designated period of time. For more information about cards, see [MoEngage - Cards](https://docs.moengage.com/docs/ios-cards). +Create targeted or automated App Inbox/NewsFeed messages that can be grouped into various categories, and target your users with different updates or offers that can stay in the Inbox/Feed over a designated period of time. For more information about cards, see [MoEngage - Cards](https://developers.moengage.com/hc/en-us/articles/4404058438676-Cards-in-iOS). #### Compliance -To make the App compliant with policies i.e,GDPR while using our SDK, follow the doc in this [link](https://docs.moengage.com/docs/gdpr-compliance-1). +To make the App compliant with policies i.e,GDPR while using our SDK, follow the doc in this [link](https://developers.moengage.com/hc/en-us/articles/4403905438228-SDK-initialisation). ### Segment Docs For more info on using **Segment for iOS** refer to [**Developer Docs**](/docs/connections/sources/catalog/libraries/mobile/ios/) provided by Segment. @@ -180,9 +188,9 @@ The MoEngage SDK depends on the below Jetpack libraries provided by Google for i done already. ```groovy - implementation("androidx.core:core:1.3.1") - implementation("androidx.appcompat:appcompat:1.2.0") - implementation("androidx.lifecycle:lifecycle-process:2.2.0") + implementation("androidx.core:core:1.6.0") + implementation("androidx.appcompat:appcompat:1.3.1") + implementation("androidx.lifecycle:lifecycle-process:2.4.0") ``` Refer to the [SDK Configuration](https://developers.moengage.com/hc/en-us/articles/4401984733972-Android-SDK-Configuration) documentation to know more about the build config and other libraries used by the SDK. @@ -216,8 +224,19 @@ Copy the APP ID from the Settings Page `Dashboard --> Settings --> App --> Gener MoEngage moEngage = new MoEngage.Builder(this, "XXXXXXXXXXX") .enableSegmentIntegration() .build(); -MoEngage.initialize(moEngage); +MoEngage.initialiseDefaultInstance(moEngage); ``` +### Exclude MoEngage Storage File from Auto-Backup +Auto backup service of Andriod periodically backs up the Shared Preference file, Database files, and so on. + +For more information, refer to [Auto Backup](https://developer.android.com/guide/topics/data/autobackup). + +The backup results in MoEngage SDK identifiers to be backed up and restored after re-install. +The restoration of the identifier results in your data being corrupted and the user not being reachable using push notifications. + +To ensure data is not corrupted after a backup is restored, opt-out of MoEngage SDK storage files. + +Refer to the [documentation](https://developers.moengage.com/hc/en-us/articles/4401999257236-Exclude-MoEngage-Storage-File-from-Auto-Backup) for further details. ### Install or update differentiation This is required for migrations to the MoEngage Platform so the SDK can determine whether the user is a new user on your app, or an existing user who updated to the latest version. @@ -225,13 +244,13 @@ This is required for migrations to the MoEngage Platform so the SDK can determin If the user was already using your application and has just updated to a new version which has the MoEngage SDK, below is an example call: ```java -MoEHelper.getInstance(getApplicationContext()).setAppStatus(AppStatus.UPDATE); + MoEAnalyticsHelper.INSTANCE.setAppStatus(context, AppStatus.UPDATE); ``` If this is a fresh install: ```java -MoEHelper.getInstance(getApplicationContext()).setAppStatus(AppStatus.INSTALL); +MoEAnalyticsHelper.INSTANCE.setAppStatus(context, AppStatus.INSTALL); ``` ### Configure Push Notifications @@ -243,7 +262,7 @@ Copy the Server Key from the FCM console and add it to the MoEngage Dashboard. T To display push notifications, some metadata regarding the notification is required. For example, the small icon and large icon drawables are mandatory. -Refer to the [MoEngage - NotificationConfig](https://moengage.github.io/android-api-reference/core/core/com.moengage.core.config/-notification-config/index.html) API reference for all the possible options. +Refer to the [MoEngage - NotificationConfig](https://moengage.github.io/android-api-reference/core/com.moengage.core.config/-notification-config/index.html) API reference for all the possible options. Use the `configureNotificationMetaData()` to pass on the configuration to the SDK. @@ -251,10 +270,10 @@ Use the `configureNotificationMetaData()` to pass on the configuration to the SD ```java MoEngage moEngage = new MoEngage.Builder(this, "XXXXXXXXXX") - .configureNotificationMetaData(new NotificationConfig(R.drawable.small_icon, R.drawable.large_icon, R.color.notiColor, "sound", true, true, true)) + .configureNotificationMetaData(new NotificationConfig(R.drawable.small_icon, R.drawable.large_icon)) .enablePartnerIntegration(IntegrationPartner.SEGMENT) .build(); -MoEngage.initialize(moEngage); +MoEngage.initialiseDefaultInstance(moEngage); ``` #### Configuring Firebase Cloud Messaging @@ -272,11 +291,11 @@ To opt-out of MoEngage token registration mechanism disable token registration w ```java MoEngage moEngage = new MoEngage.Builder(this, "XXXXXXXXXX") - .configureNotificationMetaData(new NotificationConfig(R.drawable.small_icon, R.drawable.large_icon, R.color.notiColor, "sound", true, true, true)) + .configureNotificationMetaData(new NotificationConfig(R.drawable.small_icon, R.drawable.large_icon)) .configureFcm(FcmConfig(false)) .enablePartnerIntegration(IntegrationPartner.SEGMENT) .build(); -MoEngage.initialize(moEngage); +MoEngage.initialiseDefaultInstance(moEngage); ``` ###### Pass the push token to the MoEngage SDK @@ -297,8 +316,8 @@ Before passing the payload to the MoEngage SDK you should check if the payload i ```java if (MoEPushHelper.getInstance().isFromMoEngagePlatform(remoteMessage.getData())) { - MoEFireBaseHelper.Companion.getInstance().passPushPayload(getApplicationContext(), remoteMessage.getData()); -}else{ + MoEFireBaseHelper.getInstance().passPushPayload(getApplicationContext(), remoteMessage.getData()); +} else { // your app's business logic to show notification } ``` @@ -321,10 +340,26 @@ An application can get this callback by implementing `FirebaseEventListener` and Refer to the [MoEngage - API reference](https://moengage.github.io/android-api-reference/moe-push-firebase/moe-push-firebase/com.moengage.firebase.listener/-firebase-event-listener/index.html) for more details on the listener. +##### Callbacks + +We recommend you to add the callbacks in the onCreate() of the Application class since these callbacks can be triggered even when the application is in the background. + +###### Token Callback + +When MoEngage SDK handles push registration it optionally provides a callback to the application whenever a new token is registered or the token is refreshed. To get the token callback implement the [TokenAvailableListener](https://moengage.github.io/android-api-reference/pushbase/com.moengage.pushbase.listener/-token-available-listener/index.html) and register for the callback using [MoEFireBaseHelper.getInstance().addTokenListener()](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase/-mo-e-fire-base-helper/add-token-listener.html). + +###### Non-MoEngage Payload + +If you are using the receiver provided by the SDK in your application's manifest file, SDK provides a callback in case a push payload is received for any other server apart from MoEngage Platform. To get a callback implement the [NonMoEngagePushListener](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase.listener/-non-mo-engage-push-listener/index.html) and register for the callback using [MoEFireBaseHelper.getInstance().addNonMoEngagePushListener()](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase/-mo-e-fire-base-helper/add-non-mo-engage-push-listener.html). #### Declare and configure Rich Landing Activity: +A rich landing page can be used to open a web URL inside the app via a push campaign. + +The below configuration is only required if you want to add a parent activity to the Rich landing page, if not you can move to the next section. +To use a rich landing page you need to add the below code in the AndroidManifest.xml + Add the following snippet and replace `[PARENT_ACTIVITY_NAME]` with the name of the parent activity; `[ACTIVITY_NAME]` with the activity name which should be the parent of the Rich Landing Page From 2c6951eab9ff03063295b3ca6c6d77375e682f7f Mon Sep 17 00:00:00 2001 From: umangmoe Date: Fri, 25 Mar 2022 18:17:33 +0530 Subject: [PATCH 39/51] swift package manager support added. --- src/connections/destinations/catalog/moengage/index.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/moengage/index.md b/src/connections/destinations/catalog/moengage/index.md index 27cfaec571..e25c7ea940 100644 --- a/src/connections/destinations/catalog/moengage/index.md +++ b/src/connections/destinations/catalog/moengage/index.md @@ -27,7 +27,7 @@ users it’ll be instantaneous! Segment-MoEngage Integration is a bundled integr ## iOS -To get started with MoEngage on iOS, first integrate your app with the [MoEngage-Segment-iOS](https://github.com/moengage/MoEngage-Segment-iOS) library. You can integrate MoEngage and Segment with [CocoaPods](http://cocoapods.org). +To get started with MoEngage on iOS, first integrate your app with the [MoEngage-Segment-iOS](https://github.com/moengage/MoEngage-Segment-iOS) library. You can integrate MoEngage and Segment with [CocoaPods](http://cocoapods.org) or with Swift Package Manager. * Initialize pod with pod init command, this will create a podfile for your project. * Update your podfile by adding pod '**Segment-MoEngage**' as shown below: @@ -40,6 +40,9 @@ To get started with MoEngage on iOS, first integrate your app with the [MoEngage * Update the pod. pod update + + + To install with SPM use the https://github.com/moengage/MoEngage-Segment-iOS.git and set the branch as master or version as 7.0.0 and above. ### Configure the Segment SDK: From a38fb16f9324234e50f3312f5ce97ce228d6f0a2 Mon Sep 17 00:00:00 2001 From: rchinn-segment <93161299+rchinn-segment@users.noreply.github.com> Date: Fri, 25 Mar 2022 17:44:47 -0700 Subject: [PATCH 40/51] Minor edits --- .../destinations/catalog/moengage/index.md | 78 +++++++++---------- 1 file changed, 39 insertions(+), 39 deletions(-) diff --git a/src/connections/destinations/catalog/moengage/index.md b/src/connections/destinations/catalog/moengage/index.md index e25c7ea940..b74631227f 100644 --- a/src/connections/destinations/catalog/moengage/index.md +++ b/src/connections/destinations/catalog/moengage/index.md @@ -11,7 +11,7 @@ The Segment-MoEngage Integration is a bundled integration, meaning it requires t ## Setup MoEngage in your Segment Workspace: To setup MoEngage do the following : - 1. First get your key(AppID) from the MoEngage dashboard, `Dashboard --> Settings --> App --> General`. + 1. First get your key(AppID) from the MoEngage dashboard. Navigate to `Dashboard --> Settings --> App --> General`. 2. Go to your **Segment workspace**, go to **Destinations** and select **MoEngage**. 3. Enable the MoEngage Destination. 4. Go to the MoEngage Settings and enter the MoEngage AppID, obtained in **Step1**. @@ -27,27 +27,27 @@ users it’ll be instantaneous! Segment-MoEngage Integration is a bundled integr ## iOS -To get started with MoEngage on iOS, first integrate your app with the [MoEngage-Segment-iOS](https://github.com/moengage/MoEngage-Segment-iOS) library. You can integrate MoEngage and Segment with [CocoaPods](http://cocoapods.org) or with Swift Package Manager. +To get started with MoEngage on iOS, first integrate your app with the [MoEngage-Segment-iOS](https://github.com/moengage/MoEngage-Segment-iOS){:target="_blank"} library. You can integrate MoEngage and Segment with [CocoaPods](http://cocoapods.org){:target="_blank"} or with Swift Package Manager. * Initialize pod with pod init command, this will create a podfile for your project. * Update your podfile by adding pod '**Segment-MoEngage**' as shown below: ```ruby use_frameworks! - pod 'Segment-MoEngage’ + pod 'Segment-MoEngage' ``` * Update the pod. pod update - - + + To install with SPM use the https://github.com/moengage/MoEngage-Segment-iOS.git and set the branch as master or version as 7.0.0 and above. ### Configure the Segment SDK: -Now head to the App Delegate file, and setup the Segment SDK by -1. Importing `SEGMoEngageIntegrationFactory.h` and `SEGMoEngageInitializer.h`. +Navigate to the App Delegate file, and setup the Segment SDK: +1. Import `SEGMoEngageIntegrationFactory.h` and `SEGMoEngageInitializer.h`. 2. Initialize `MOSDKConfig` object and call `initializeDefaultInstance:` method of `SEGMoEngageInitializer`. 3. Initialize `SEGMoEngageIntegrationFactory` instance to the `SEGAnalyticsConfiguration` as shown below: @@ -61,7 +61,7 @@ Now head to the App Delegate file, and setup the Segment SDK by //Initialize SDKConfig object and call initializeDefaultInstance: method of SEGMoEngageInitializer MOSDKConfig* sdkConfig = [[MOSDKConfig alloc] initWithAppID:@"YOUR APP ID"]; [SEGMoEngageInitializer initializeDefaultInstance:sdkConfig]; - + // Add your configuration key from Segment SEGAnalyticsConfiguration *config = [SEGAnalyticsConfiguration configurationWithWriteKey:@"configuration key"]; @@ -117,11 +117,11 @@ To differentiate between those, use one of the method below: [[MoEngage sharedInstance] appStatus:AppStatusUpdate]; ``` -Read more on [install/update differentiation](https://developers.moengage.com/hc/en-us/articles/4403910297620). +Read more on [install/update differentiation](https://developers.moengage.com/hc/en-us/articles/4403910297620){:target="_blank"}. ### Set the data center -By default, the data center setting in the SDK is set to `data_center_01`. Follow the steps in the [MoEngage - Data Redirection](https://developers.moengage.com/hc/en-us/articles/4403910162452-Data-Center) to update the data center value. If not set correctly, several features of the MoEngage SDK will not function. +By default, the data center setting in the SDK is set to `data_center_01`. Follow the steps in the [MoEngage - Data Redirection](https://developers.moengage.com/hc/en-us/articles/4403910162452-Data-Center){:target="_blank"} to update the data center value. If not set correctly, several features of the MoEngage SDK will not function. ### Using features provided in the MoEngage SDK @@ -150,19 +150,19 @@ Push Notifications are a great way to keep your users engaged and informed about ``` **MoEngage Push Implementation:** -For information about the MoEngage push implementation, see [**Push Notifications**](https://developers.moengage.com/hc/en-us/articles/4403943988756) in the MoEngage documentation. +For information about the MoEngage push implementation, see [**Push Notifications**](https://developers.moengage.com/hc/en-us/articles/4403943988756){:target="_blank"} in the MoEngage documentation. #### In-app messaging -In-App Messages are custom views which you can send to a set of users to show custom messages, give new offers, or direct to a specific page. For more information about In-app messaging, see [MoEngage - In-App NATIV](https://developers.moengage.com/hc/en-us/articles/4404155127828-In-App-Nativ) +In-App Messages are custom views which you can send to a set of users to show custom messages, give new offers, or direct to a specific page. For more information about In-app messaging, see [MoEngage - In-App NATIV](https://developers.moengage.com/hc/en-us/articles/4404155127828-In-App-Nativ){:target="_blank"}. #### Cards -Create targeted or automated App Inbox/NewsFeed messages that can be grouped into various categories, and target your users with different updates or offers that can stay in the Inbox/Feed over a designated period of time. For more information about cards, see [MoEngage - Cards](https://developers.moengage.com/hc/en-us/articles/4404058438676-Cards-in-iOS). +Create targeted or automated App Inbox/NewsFeed messages that can be grouped into various categories, and target your users with different updates or offers that can stay in the Inbox/Feed over a designated period of time. For more information about cards, see [MoEngage - Cards](https://developers.moengage.com/hc/en-us/articles/4404058438676-Cards-in-iOS){:target="_blank"}. #### Compliance -To make the App compliant with policies i.e,GDPR while using our SDK, follow the doc in this [link](https://developers.moengage.com/hc/en-us/articles/4403905438228-SDK-initialisation). +To make the App compliant with policies i.e,GDPR while using our SDK, follow the doc in this [link](https://developers.moengage.com/hc/en-us/articles/4403905438228-SDK-initialisation){:target="_blank"}. ### Segment Docs For more info on using **Segment for iOS** refer to [**Developer Docs**](/docs/connections/sources/catalog/libraries/mobile/ios/) provided by Segment. @@ -195,7 +195,7 @@ The MoEngage SDK depends on the below Jetpack libraries provided by Google for i implementation("androidx.appcompat:appcompat:1.3.1") implementation("androidx.lifecycle:lifecycle-process:2.4.0") ``` -Refer to the [SDK Configuration](https://developers.moengage.com/hc/en-us/articles/4401984733972-Android-SDK-Configuration) documentation to know more about the build config and other libraries used by the SDK. +Refer to the [SDK Configuration](https://developers.moengage.com/hc/en-us/articles/4401984733972-Android-SDK-Configuration){:target="_blank"} documentation to know more about the build config and other libraries used by the SDK. ### Register MoEngage with Segment SDK @@ -232,14 +232,14 @@ MoEngage.initialiseDefaultInstance(moEngage); ### Exclude MoEngage Storage File from Auto-Backup Auto backup service of Andriod periodically backs up the Shared Preference file, Database files, and so on. -For more information, refer to [Auto Backup](https://developer.android.com/guide/topics/data/autobackup). +For more information, refer to [Auto Backup](https://developer.android.com/guide/topics/data/autobackup){:target="_blank"}. -The backup results in MoEngage SDK identifiers to be backed up and restored after re-install. +As a result of the backup, MoEngage SDK identifiers are backed up and restored after re-install. The restoration of the identifier results in your data being corrupted and the user not being reachable using push notifications. -To ensure data is not corrupted after a backup is restored, opt-out of MoEngage SDK storage files. +To ensure data isn't corrupted after a backup is restored, opt-out of MoEngage SDK storage files. -Refer to the [documentation](https://developers.moengage.com/hc/en-us/articles/4401999257236-Exclude-MoEngage-Storage-File-from-Auto-Backup) for further details. +Refer to the [documentation](https://developers.moengage.com/hc/en-us/articles/4401999257236-Exclude-MoEngage-Storage-File-from-Auto-Backup){:target="_blank"} for further details. ### Install or update differentiation This is required for migrations to the MoEngage Platform so the SDK can determine whether the user is a new user on your app, or an existing user who updated to the latest version. @@ -265,7 +265,7 @@ Copy the Server Key from the FCM console and add it to the MoEngage Dashboard. T To display push notifications, some metadata regarding the notification is required. For example, the small icon and large icon drawables are mandatory. -Refer to the [MoEngage - NotificationConfig](https://moengage.github.io/android-api-reference/core/com.moengage.core.config/-notification-config/index.html) API reference for all the possible options. +Refer to the [MoEngage - NotificationConfig](https://moengage.github.io/android-api-reference/core/com.moengage.core.config/-notification-config/index.html){:target="_blank"} API reference for all the possible options. Use the `configureNotificationMetaData()` to pass on the configuration to the SDK. @@ -341,7 +341,7 @@ When the MoEngage SDK handles push registration, it optionally provides a callba An application can get this callback by implementing `FirebaseEventListener` and registering for a callback in the Application class `onCreate()` using `MoEFireBaseHelper.getInstance().addEventListener()` -Refer to the [MoEngage - API reference](https://moengage.github.io/android-api-reference/moe-push-firebase/moe-push-firebase/com.moengage.firebase.listener/-firebase-event-listener/index.html) for more details on the listener. +Refer to the [MoEngage - API reference](https://moengage.github.io/android-api-reference/moe-push-firebase/moe-push-firebase/com.moengage.firebase.listener/-firebase-event-listener/index.html){:target="_blank"} for more details on the listener. ##### Callbacks @@ -349,18 +349,18 @@ We recommend you to add the callbacks in the onCreate() of the Application class ###### Token Callback -When MoEngage SDK handles push registration it optionally provides a callback to the application whenever a new token is registered or the token is refreshed. To get the token callback implement the [TokenAvailableListener](https://moengage.github.io/android-api-reference/pushbase/com.moengage.pushbase.listener/-token-available-listener/index.html) and register for the callback using [MoEFireBaseHelper.getInstance().addTokenListener()](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase/-mo-e-fire-base-helper/add-token-listener.html). +When MoEngage SDK handles push registration, it optionally provides a callback to the application whenever a new token is registered or the token is refreshed. To get the token callback implement the [TokenAvailableListener](https://moengage.github.io/android-api-reference/pushbase/com.moengage.pushbase.listener/-token-available-listener/index.html){:target="_blank"} and register for the callback using [MoEFireBaseHelper.getInstance().addTokenListener()](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase/-mo-e-fire-base-helper/add-token-listener.html){:target="_blank"}. ###### Non-MoEngage Payload -If you are using the receiver provided by the SDK in your application's manifest file, SDK provides a callback in case a push payload is received for any other server apart from MoEngage Platform. To get a callback implement the [NonMoEngagePushListener](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase.listener/-non-mo-engage-push-listener/index.html) and register for the callback using [MoEFireBaseHelper.getInstance().addNonMoEngagePushListener()](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase/-mo-e-fire-base-helper/add-non-mo-engage-push-listener.html). +If you're using the receiver provided by the SDK in your application's manifest file, SDK provides a callback in case a push payload is received for any other server apart from MoEngage Platform. To get a callback implement the [NonMoEngagePushListener](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase.listener/-non-mo-engage-push-listener/index.html){:target="_blank"} and register for the callback using [MoEFireBaseHelper.getInstance().addNonMoEngagePushListener()](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase/-mo-e-fire-base-helper/add-non-mo-engage-push-listener.html){:target="_blank"}. #### Declare and configure Rich Landing Activity: A rich landing page can be used to open a web URL inside the app via a push campaign. -The below configuration is only required if you want to add a parent activity to the Rich landing page, if not you can move to the next section. +The configuration below is only required if you want to add a parent activity to the Rich landing page. If not, you can move to the next section. To use a rich landing page you need to add the below code in the AndroidManifest.xml Add the following snippet and replace `[PARENT_ACTIVITY_NAME]` with the name of the parent @@ -376,23 +376,23 @@ Add the following snippet and replace `[PARENT_ACTIVITY_NAME]` with the name of You are now all set up to receive push notifications from MoEngage. For more information on features provided in MoEngage Android SDK refer to the following links: -* [Push Notifications](https://developers.moengage.com/hc/en-us/sections/360013606771-Push) +* [Push Notifications](https://developers.moengage.com/hc/en-us/sections/360013606771-Push){:target="_blank"} -* [Location Triggered](https://developers.moengage.com/hc/en-us/articles/4403443036564-Location-Triggered) +* [Location Triggered](https://developers.moengage.com/hc/en-us/articles/4403443036564-Location-Triggered){:target="_blank"} -* [In-App messaging](https://developers.moengage.com/hc/en-us/sections/360013831431-In-App-Messages) +* [In-App messaging](https://developers.moengage.com/hc/en-us/sections/360013831431-In-App-Messages){:target="_blank"} -* [Notification Center](https://developers.moengage.com/hc/en-us/articles/4403878923284-Notification-Center) +* [Notification Center](https://developers.moengage.com/hc/en-us/articles/4403878923284-Notification-Center){:target="_blank"} -* [API Reference](https://moengage.github.io/android-api-reference/index.html) +* [API Reference](https://moengage.github.io/android-api-reference/index.html){:target="_blank"} -* [Compliance](https://developers.moengage.com/hc/en-us/sections/4403894212116-Compliance) +* [Compliance](https://developers.moengage.com/hc/en-us/sections/4403894212116-Compliance){:target="_blank"} -* [Release Notes](https://developers.moengage.com/hc/en-us/articles/4403896795540-Changelog) +* [Release Notes](https://developers.moengage.com/hc/en-us/articles/4403896795540-Changelog){:target="_blank"} ### Identify -Use [Identify](/docs/connections/sources/catalog/libraries/mobile/android/#identify) to track user-specific attributes. This is the same as tracking [user attributes](http://docs.moengage.com/docs/identifying-user) on MoEngage. MoEngage supports traits supported by Segment as well as custom traits. If you set traits.id, MoEngage sets that as the Unique ID for that user. +Use [Identify](/docs/connections/sources/catalog/libraries/mobile/android/#identify) to track user-specific attributes. This is the same as tracking [user attributes](http://docs.moengage.com/docs/identifying-user){:target="_blank"} on MoEngage. MoEngage supports traits supported by Segment as well as custom traits. If you set traits.id, MoEngage sets that as the Unique ID for that user. ### Track Use [track](/docs/connections/sources/catalog/libraries/mobile/android/#track) to track events and user behavior in your app. @@ -403,7 +403,7 @@ If your app supports the ability for a user to logout and login with a new ident ### Sample Implementation -Refer to [this](https://github.com/moengage/moengage-segment-integration) Github repository for sample implementation +Refer to [this](https://github.com/moengage/moengage-segment-integration){:target="_blank"} Github repository for sample implementation ## Web @@ -413,14 +413,14 @@ The MoEngage WebSDK offers the ability to send push notifications to Google Chro ### Integration #### 1. Setup your MoEngage Web SDK settings at MoEngage Dashboard -Configure the [web settings](https://app.moengage.com/v3/#/settings/push/web) on the MoEngage dashboard to start using MoEngage <> Segment integration. +Configure the [web settings](https://app.moengage.com/v3/#/settings/push/web){:target="_blank"} on the MoEngage dashboard to start using MoEngage <> Segment integration. If you have selected `HTTPS` mode of integration in the settings, complete the following steps: #### 2 Set up for HTTPS websites #### 2.a Download the required files (HTTPS) -For HTTPS Web Push to work, you need to host two files in the `root` directory of your web server. These two files will be available for you to download at the [web settings page](https://app.moengage.com/v3/#/settings/push/web). +For HTTPS Web Push to work, you need to host two files in the `root` directory of your web server. These two files will be available for you to download at the [web settings page](https://app.moengage.com/v3/#/settings/push/web){:target="_blank"}. * manifest.json * serviceworker.js @@ -457,7 +457,7 @@ If you already have these files, ``` ### Identify -Use [Identify](/docs/sources/website/analytics.js/#identify) to track user specific attributes. This is equal to [tracking user attributes](https://docs.moengage.com/docs/tracking-web-user-attributes) on MoEngage. MoEngage supports traits supported by Segment as well as custom traits. +Use [Identify](/docs/sources/website/analytics.js/#identify) to track user specific attributes. This is equal to [tracking user attributes](https://docs.moengage.com/docs/tracking-web-user-attributes){:target="_blank"} on MoEngage. MoEngage supports traits supported by Segment as well as custom traits. ### Track Use [track](/docs/sources/website/analytics.js/#track) to track events and user behavior in your app. This will send the event to MoEngage with the associated properties. Tracking events is essential and will help you create segments for engaging users. @@ -467,9 +467,9 @@ If your website supports the ability for a user to logout and login with a new i ### Optional For information about optional feature, see the documentation below: -* [Configure opt in type](https://docs.moengage.com/docs/configuring-notification-opt-in) -* [Self-handled opt-ins](https://docs.moengage.com/docs/self-handled-opt-ins) -* [SDK callbacks](https://docs.moengage.com/docs/tracking-opt-ins-on-your-own) +* [Configure opt in type](https://docs.moengage.com/docs/configuring-notification-opt-in){:target="_blank"} +* [Self-handled opt-ins](https://docs.moengage.com/docs/self-handled-opt-ins){:target="_blank"} +* [SDK callbacks](https://docs.moengage.com/docs/tracking-opt-ins-on-your-own){:target="_blank"} ### Test Mode and Debugging While updating the MoEngage settings on the Segment Dashboard, you can enable the logging functionality of the MoEngage SDK to see the SDK logs on the browser console. Just set `Enable Debug Logging` to `On` and the SDK loads in debug mode. From 6ef0bebd8342217b27f57983aee7602326a3722b Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Mon, 28 Mar 2022 08:35:04 -0400 Subject: [PATCH 41/51] DOC-452 Changing properties based on PM feedback --- .../catalog/cloud-apps/zendesk/index.md | 21 ++++++++++--------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index a1bdd31c99..357c9b9a45 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -148,7 +148,7 @@ In your warehouse, each collection gets its own table. Find below a list of the | created_at | The date and time this record was created. | | updated_at | The date and time this record was last updated. | | received_at | This timestamp is added to incoming messages as soon as they hit Segment API. | -| ticket_form_id | The ID of the ticket form to render the ticket (Enterprise only). | +| ticket_form_id | The ID of the ticket form to render the ticket. | ### ticket_fields @@ -286,7 +286,7 @@ In your warehouse, each collection gets its own table. Find below a list of the | Property | Description | | --------------- | ----------------------------------------------------------------- | -| id | Automatically assigned when the ticket form is created. | +| id | The ID of the ticket form. | | active | If set to true, this shows that the form is active. | | end_user_visible | If set to true, this shows that the form is visible to end users.| | name | The name of the form. | @@ -306,7 +306,8 @@ In your warehouse, each collection gets its own table. Find below a list of the | Property | Description | | --------------- | ----------------------------------------------------------------- | -| id | Automatically assigned upon ticket skip creation. | +| id | The ID of the ticket skip record. | +| ticket_id | The ID of the skipped ticket. | | user_id | The ID of the skipping agent. | | reason | The reason for skipping the ticket. | | created_at | The date and time the skip was created. | @@ -316,19 +317,19 @@ In your warehouse, each collection gets its own table. Find below a list of the | Property | Description | | --------------- | ----------------------------------------------------------------- | -| id | Automatically assigned when creating organizations. | -| url | The URL of this organization. | -| user_id | The ID of the user associated with this organization. | -| organization_id | The ID of the organization associated with the selected user | +| id | The ID of the organization membership. | +| url | The API URL of the membership. | +| user_id | The ID of the user for whom this membership belongs. | +| organization_id | The ID of the organization associated with the selected user, in this membership. | | created_at | The date and time this record was created. | | updated_at | The date and time this record was last updated. | -| organization_name | The name of the organization associated with the selected user. | +| organization_name | The name of the organization associated with the selected user, in this membership. | ### group_memberships | Property | Description | | --------------- | ----------------------------------------------------------------- | -| id | Automatically assigned when creating groups. | +| id | The ID of the group membership. | | url | The API URL of this group. | | created_at | The date and time the group was created. | | group_id | The ID of the group. | @@ -339,7 +340,7 @@ In your warehouse, each collection gets its own table. Find below a list of the | Property | Description | | --------------- | ----------------------------------------------------------------- | -| id | Automatically assigned when creating audit logs. | +| id | The ID of the audit log. | | url | The URL to access the audit log. | | created_at | The date and time that the audit was created. | | actor_id | The ID of the user creating the ticket. | From ce26a3485258d78f8936c97d0d8c09d4e32ed09d Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Mon, 28 Mar 2022 08:45:28 -0400 Subject: [PATCH 42/51] [netlify-build] --- src/connections/sources/catalog/cloud-apps/zendesk/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index 357c9b9a45..5eafb71b25 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -353,4 +353,4 @@ In your warehouse, each collection gets its own table. Find below a list of the | action_label | A localized string of action field. | ## Adding Destinations -Currently only Warehouses are supported for object-cloud sources. \ No newline at end of file +Currently only Warehouses are supported for object-cloud sources. From 3c5a77653f50c6a7b582f1c3d56e0fc6879421f9 Mon Sep 17 00:00:00 2001 From: stayseesong Date: Mon, 28 Mar 2022 17:26:23 -0700 Subject: [PATCH 43/51] [netlify-build] --- .../destinations/catalog/salesforce-marketing-cloud/index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/salesforce-marketing-cloud/index.md b/src/connections/destinations/catalog/salesforce-marketing-cloud/index.md index 948656cc02..ba51697929 100644 --- a/src/connections/destinations/catalog/salesforce-marketing-cloud/index.md +++ b/src/connections/destinations/catalog/salesforce-marketing-cloud/index.md @@ -196,6 +196,8 @@ The example below shows a Data Extension for `User Registered` Track calls that ![](images/dext-user-regd-example.png) +> warning "" +> Segment doesn't automatically send timestamps. You must add timestamps as a property in the Track Call to send timestamps to the destination. ### Configure the SFMC Destination in Segment @@ -281,7 +283,7 @@ In order to do this, you must have access to **Personas**. To learn more, [conta > **Tip**: We recommend that you use [SFMC batching](#optional-set-up-sfmc-batching) with Personas to help reduce the number of API calls that you send to SFMC, but this is optional. If you choose to set up batching, do this _before_ you set up the SFMC destination in your Segment workspace. Personas sends audience membership and computed trait values to SFMC using Identify calls. To integrate Personas with SFMC: -1. [Create a Data Extension to store Identify calls](#create-a-data-extension-in-sfmc-to-store-identify-calls) if you haven't already. +1. [Create a Data Extension to store Identify calls](#create-a-data-extension-in-sfmc-to-store-identify-calls) if you haven't already. 2. [Configure SFMC as a Personas Destination](#configure-the-salesforce-marketing-cloud-destination-in-segment) When you sync to an existing Data Extension, note these additional requirements: From 590acf5848abaf22648c275505c90ae6e57f280a Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Tue, 29 Mar 2022 08:26:17 -0400 Subject: [PATCH 44/51] DOC-452 Updating collection descriptions as per engineering [netlify-build] --- src/connections/sources/catalog/cloud-apps/zendesk/index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index 5eafb71b25..132d074e2e 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -63,8 +63,8 @@ Collections are the groupings of resources Segment pulls from your source. | [ticket_comments](#ticket_comments) | object | Ticket comments represent the conversation between requesters, collaborators, and agents. It includes the full body of each comment, public and private. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | | [ticket_forms](#ticket_forms) | object | Ticket forms allow an admin to define a subset of ticket fields for display to both agents and end users. | | [ticket_skips](#ticket_skips) | object | A skip is a record of when an agent skips over a ticket without responding to the end user. | -| [organization_memberships](#organization_memberships) | object | A membership links a user to an organization. Organizations can have many users. Users can be in many organizations if the account supports multiple organizations. You can use the API to list users in an organization, and reassign organization members. | -| [group_memberships](#group_memberships) | object | A membership links an agent to a group. Groups can have many agents, as agents can be in many groups. You can use the API to list what agents are in which groups, and reassign group members. | +| [organization_memberships](#organization_memberships) | object | An organization_membership links a user to an organization. Organizations can have many users. Users can be in many organizations if the account supports multiple organizations. | +| [group_memberships](#group_memberships) | object | A group_membership links an agent to a group. Groups can have many agents, as agents can be in many groups. | | [audit_logs](#audit_logs) | object | The audit log shows various changes in your instance of Zendesk since the account was created. **Note**: This collection is not included by default. To request it, [contact Segment support](https://segment.com/help/contact/). | From c6c7bb6b0b75db06aab9e7563388bf1f0d4d11b1 Mon Sep 17 00:00:00 2001 From: rchinn-segment <93161299+rchinn-segment@users.noreply.github.com> Date: Tue, 29 Mar 2022 15:17:31 -0700 Subject: [PATCH 45/51] Update src/connections/destinations/catalog/moengage/index.md --- src/connections/destinations/catalog/moengage/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/moengage/index.md b/src/connections/destinations/catalog/moengage/index.md index b74631227f..fd5277a68a 100644 --- a/src/connections/destinations/catalog/moengage/index.md +++ b/src/connections/destinations/catalog/moengage/index.md @@ -42,7 +42,7 @@ To get started with MoEngage on iOS, first integrate your app with the [MoEngage pod update - To install with SPM use the https://github.com/moengage/MoEngage-Segment-iOS.git and set the branch as master or version as 7.0.0 and above. + To install with SPM use the [MoEngage-Segment-iOS](https://github.com/moengage/MoEngage-Segment-iOS.git){:target="_blank"} library and set the branch as master or version as 7.0.0 and above. ### Configure the Segment SDK: From ca878e29336854ad6236cc58f81133c161280886 Mon Sep 17 00:00:00 2001 From: rchinn-segment <93161299+rchinn-segment@users.noreply.github.com> Date: Tue, 29 Mar 2022 15:17:51 -0700 Subject: [PATCH 46/51] Update src/connections/destinations/catalog/moengage/index.md --- src/connections/destinations/catalog/moengage/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/moengage/index.md b/src/connections/destinations/catalog/moengage/index.md index fd5277a68a..b73ffd26b1 100644 --- a/src/connections/destinations/catalog/moengage/index.md +++ b/src/connections/destinations/catalog/moengage/index.md @@ -162,7 +162,7 @@ Create targeted or automated App Inbox/NewsFeed messages that can be grouped int #### Compliance -To make the App compliant with policies i.e,GDPR while using our SDK, follow the doc in this [link](https://developers.moengage.com/hc/en-us/articles/4403905438228-SDK-initialisation){:target="_blank"}. +To make the App compliant with policies (such as GDPR) while using MoEngage's SDK, follow the instructions in this [doc](https://developers.moengage.com/hc/en-us/articles/4403905438228-SDK-initialisation){:target="_blank"}. ### Segment Docs For more info on using **Segment for iOS** refer to [**Developer Docs**](/docs/connections/sources/catalog/libraries/mobile/ios/) provided by Segment. From 353ea49673b984b07c5280b9f138c03ff34b0cb3 Mon Sep 17 00:00:00 2001 From: Mark Urquhart Date: Wed, 30 Mar 2022 07:10:30 -0400 Subject: [PATCH 47/51] Correcting Page methods name MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit ‘destinations.methods.page_view’ should be ‘destinations.methods.page’ to match the naming convention found in destinations.yml --- src/connections/destinations/methods-compare.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/src/connections/destinations/methods-compare.md b/src/connections/destinations/methods-compare.md index fcbfba6682..c3fd9143ad 100644 --- a/src/connections/destinations/methods-compare.md +++ b/src/connections/destinations/methods-compare.md @@ -18,11 +18,11 @@ This page lists which [Segment methods](/docs/connections/spec/) each destinatio Alias 🏷 {% for destination in site.data.catalog.destinations.items %} -{% unless destination.methods.track == false and destination.methods.page_view == false and destination.methods.identify == false and destination.methods.group == false and destination.methods.alias == false %} +{% unless destination.methods.track == false and destination.methods.page == false and destination.methods.identify == false and destination.methods.group == false and destination.methods.alias == false %} {% if destination.status == "PUBLIC_BETA" %}ℹ️ {% endif %}**[{{ destination.display_name }}](/docs/{{ destination.url }})** {% if destination.methods.track %}✅{% else %}⬜️{% endif %} - {% if destination.methods.page_view %}✅{% else %}⬜️{% endif %} + {% if destination.methods.page %}✅{% else %}⬜️{% endif %} {% if destination.methods.identify %}✅{% else %}⬜️{% endif %} {% if destination.methods.group %}✅{% else %}⬜️{% endif %} {% if destination.methods.alias %}✅{% else %}⬜️{% endif %} @@ -34,7 +34,7 @@ This page lists which [Segment methods](/docs/connections/spec/) each destinatio #### The following destinations have no method information available: {% for destination in site.data.catalog.destinations.items %} -{% if destination.methods.track == false and destination.methods.page_view == false and destination.methods.identify == false and destination.methods.group == false and destination.methods.alias == false %} +{% if destination.methods.track == false and destination.methods.page == false and destination.methods.identify == false and destination.methods.group == false and destination.methods.alias == false %} - [{{ destination.display_name }}](/docs/{{ destination.url }}){% if destination.status == "PUBLIC_BETA" %} (beta){% endif %} {% endif %} {% endfor %} From 04dca4e01b6650d495ec83279d049bd599ea62be Mon Sep 17 00:00:00 2001 From: tobiordobi <88668535+tobiordobi@users.noreply.github.com> Date: Thu, 31 Mar 2022 09:29:28 +0100 Subject: [PATCH 48/51] Update Ambassador destination docs --- src/connections/destinations/catalog/ambassador/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/ambassador/index.md b/src/connections/destinations/catalog/ambassador/index.md index 6e70f61358..9b9d2ec49b 100644 --- a/src/connections/destinations/catalog/ambassador/index.md +++ b/src/connections/destinations/catalog/ambassador/index.md @@ -16,7 +16,7 @@ id: 573a3dfb80412f644ff13679 Your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading the Ambassador snippet on your page and sending data. -Since Ambassador only records specific events and user data, events and users may not appear in Ambassador until you start using the API explained below. +Since Ambassador only records specific events and user data, events and users may not appear in Ambassador until you start using the API explained below. And you must approve your website domain via the Editor -> Manage websites section in the navigation pane along the left-hand side of the page. ## Identify From 02e882d52a34d8153f560885a613aa8006cb36c2 Mon Sep 17 00:00:00 2001 From: tobiordobi <88668535+tobiordobi@users.noreply.github.com> Date: Thu, 31 Mar 2022 09:33:13 +0100 Subject: [PATCH 49/51] Update index.md --- src/connections/destinations/catalog/ambassador/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/connections/destinations/catalog/ambassador/index.md b/src/connections/destinations/catalog/ambassador/index.md index 9b9d2ec49b..28cddd8cdc 100644 --- a/src/connections/destinations/catalog/ambassador/index.md +++ b/src/connections/destinations/catalog/ambassador/index.md @@ -16,7 +16,7 @@ id: 573a3dfb80412f644ff13679 Your changes appear in the Segment CDN in about 45 minutes, and then Analytics.js starts asynchronously loading the Ambassador snippet on your page and sending data. -Since Ambassador only records specific events and user data, events and users may not appear in Ambassador until you start using the API explained below. And you must approve your website domain via the Editor -> Manage websites section in the navigation pane along the left-hand side of the page. +Since Ambassador only records specific events and user data, events and users may not appear in Ambassador until you start using the API explained below. And you must approve your website domain through the Editor -> Manage websites section in the navigation pane along the left-hand side of the page. ## Identify From b0c02e28bb6c997e67c317b13542ee185f809946 Mon Sep 17 00:00:00 2001 From: forstisabella <92472883+forstisabella@users.noreply.github.com> Date: Thu, 31 Mar 2022 10:27:10 -0400 Subject: [PATCH 50/51] [DOC-452] Addressing comments left in code review [netlify-build] --- .../catalog/cloud-apps/zendesk/index.md | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/src/connections/sources/catalog/cloud-apps/zendesk/index.md b/src/connections/sources/catalog/cloud-apps/zendesk/index.md index 132d074e2e..ee3c84946b 100644 --- a/src/connections/sources/catalog/cloud-apps/zendesk/index.md +++ b/src/connections/sources/catalog/cloud-apps/zendesk/index.md @@ -77,7 +77,7 @@ In your warehouse, each collection gets its own table. Find below a list of the | Property | Description | | ----------- | -------------------------------------------- | -| id | Automatically assigned when creating groups. | +| id | This is automatically assigned when creating groups. | | url | The API URL of this group. | | deleted | Deleted groups get marked as such. | | name | The name of the group. | @@ -89,7 +89,7 @@ In your warehouse, each collection gets its own table. Find below a list of the | Property | Description | | --------------- | ----------------------------------------------------------------- | -| id | Automatically assigned when the user is created. | +| id | This is automatically assigned when the user is created. | | url | Segment sets the “url” field users see in their Warehouse to equal the “id” from Zendesk, rather than the “url” field. | | name | The name of the user. | | email | The primary email address of the user. | @@ -123,7 +123,7 @@ In your warehouse, each collection gets its own table. Find below a list of the | Property | Description | | --------------- | ----------------------------------------------------------------- | -| id | Automatically assigned when the ticket is created. | +| id | This is automatically assigned when the ticket is created. | | url | The API URL of this ticket. | | external_id | An ID you can use to link Zendesk Support tickets to local records. | | type | The type of this ticket. Possible values: “problem”, “incident”, “question” or “task”. | @@ -154,7 +154,7 @@ In your warehouse, each collection gets its own table. Find below a list of the | Property | Description | | --------------- | ----------------------------------------------------------------- | -| id | Automatically assigned upon creation. | +| id | This is automatically assigned upon creation. | | url | The URL for this resource. | | type | The type of the ticket field: “checkbox”, “date”, “decimal”, “integer”, “regexp”, “tagger”, “text”, or “textarea”. _*Type is not editable once created._ | | slug | The title of the ticket field separated by _. | @@ -182,7 +182,7 @@ In your warehouse, each collection gets its own table. Find below a list of the | Property | Description | | --------------- | ----------------------------------------------------------------- | -| id | Automatically assigned. | +| id | This is automatically assigned. | | ticket_id | ID of the associated ticket. | | group_stations | Number of groups this ticket passed through. | | assignee_stations | Number of assignees this ticket had. | @@ -214,8 +214,8 @@ In your warehouse, each collection gets its own table. Find below a list of the | Property | Description | | --------------- | ----------------------------------------------------------------- | -| id | Automatically assigned. | -| ticket_event_id | Automatically assigned when the ticket is updated. | +| id | This is automatically assigned. | +| ticket_event_id | This is automatically assigned when the ticket is updated. | | ticket_id | The ID of the associated ticket. | | timestamp | The time when the ticket was updated. | | updater_id | The ID of the user who updated the ticket. | @@ -231,7 +231,7 @@ In your warehouse, each collection gets its own table. Find below a list of the | Property | Description | | --------------- | ----------------------------------------------------------------- | -| id | Automatically assigned upon creation. | +| id | This is automatically assigned upon creation. | | url | The API URL of this activity. | | verb | The type of activity. Can be "tickets.assignment," "tickets.comment," or "tickets.priority_increase." | | title | Description of this activity. | @@ -242,7 +242,7 @@ In your warehouse, each collection gets its own table. Find below a list of the | Property | Description | | --------------- | ----------------------------------------------------------------- | -| id | Automatically assigned upon creation. | +| id | This is automatically assigned upon creation. | | file_name | The name of the image file. | | content_url | A full URL where the attachment image file can be downloaded. | | content_type | The content type of the image. Example value: image/png. | @@ -254,7 +254,7 @@ In your warehouse, each collection gets its own table. Find below a list of the | Property | Description | | --------------- | ----------------------------------------------------------------- | -| id | Automatically assigned when the organization is created. | +| id | This is automatically assigned when the organization is created. | | external_id | A unique external ID to associate organizations to an external record. | | url | The API URL of this organization. | | name | A unique name for the organization. | @@ -271,8 +271,8 @@ In your warehouse, each collection gets its own table. Find below a list of the | Property | Description | | --------------- | ----------------------------------------------------------------- | -| id | Automatically assigned when the comment is created. | -| ticket_event_id | Automatically assigned when the comment is created. | +| id | This is automatically assigned when the comment is created. | +| ticket_event_id | This is automatically assigned when the comment is created. | | ticket_id | The ID of the ticket being commented. | | type | Comment or VoiceComment. The JSON object for voice comments is different. | | body | The comment string. | From c5f3941ec5f44e94e50e87fee2142a0335b4ae13 Mon Sep 17 00:00:00 2001 From: pwseg <86626706+pwseg@users.noreply.github.com> Date: Thu, 31 Mar 2022 11:18:11 -0500 Subject: [PATCH 51/51] Update product-limits.md --- src/personas/product-limits.md | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/src/personas/product-limits.md b/src/personas/product-limits.md index 9707707cfd..abad74b0b0 100644 --- a/src/personas/product-limits.md +++ b/src/personas/product-limits.md @@ -56,13 +56,8 @@ To learn more about custom limits and upgrades, contact your dedicated Customer ## Journeys - -In addition to [Personas Default Limits](#default-limits), Journeys enforces default limits to ensure feature performance and reliability. - -| Item | Limit description | Details | -| ------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| Journeys | 10 Journeys per workspace | Applies to active, concurrent Journeys.

Once the limit is reached, you cannot publish any additional Journeys. You will still be able to create draft Journeys. | -| Journey steps | 20 steps per Journey | This applies to certain steps:

- Initial cohort: 1
- Wait for condition: 1
- True / False Split: 1
- Multi-Branch Split: Number of branches
- Send to Destinations: 1

Once the limit is reached, you will be unable to add additional steps to the Journey. | -| Journey Name | Maximum length of 73 characters | Once the limit is reached, you cannot add additional characters to the name. | -| Step Name | Maximum length of 170 characters | Once the limit is reached, you cannot add additional characters to the name. | -| Key | Maximum length of 255 characters | Once the limit is reached, you cannot add additional characters to the key. | +| Item | Limit description | Details | +| ------------ | -------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Journey Name | Maximum length of 73 characters | Once the limit is reached, you cannot add additional characters to the name. | +| Step Name | Maximum length of 170 characters | Once the limit is reached, you cannot add additional characters to the name. | +| Key | Maximum length of 255 characters | Once the limit is reached, you cannot add additional characters to the key. |