-
Notifications
You must be signed in to change notification settings - Fork 5
feat: add self-service account deletion docs #1354
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,47 @@ | ||||||||||||||||||
| --- | ||||||||||||||||||
| title: Account deletion | ||||||||||||||||||
| description: Learn how to permanently delete your Knock account and what happens to your data. | ||||||||||||||||||
| tags: ["account", "deletion", "delete"] | ||||||||||||||||||
| section: Manage your account | ||||||||||||||||||
| --- | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Overview | ||||||||||||||||||
|
|
||||||||||||||||||
| Account owners can permanently delete their Knock account from the dashboard. This action is irreversible. Once you delete your account, all data associated with it is permanently removed and cannot be recovered. | ||||||||||||||||||
|
|
||||||||||||||||||
| ## Before you delete | ||||||||||||||||||
|
|
||||||||||||||||||
| Consider the following before deleting your account: | ||||||||||||||||||
|
|
||||||||||||||||||
| - **Production workflows.** Deactivate or migrate any production workflows that are still sending notifications. Deleting your account will immediately stop all notification delivery. | ||||||||||||||||||
| - **API keys.** All API keys will be revoked immediately. Any applications or services using these keys will lose access to Knock. | ||||||||||||||||||
| - **Account members.** All [account members](/manage-your-account/managing-members) will lose access. They will receive an email informing them that the account has been deleted. | ||||||||||||||||||
| - **Integrations.** Any active channel integrations (email, push, chat, SMS) will stop working. | ||||||||||||||||||
|
|
||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Is it worth adding historical records / message logs here? I know it's addressed in the section below, so might be overkill. |
||||||||||||||||||
| ## What happens to your data | ||||||||||||||||||
|
|
||||||||||||||||||
| When you delete your account, Knock permanently removes all data associated with it: | ||||||||||||||||||
|
|
||||||||||||||||||
| - **Account data.** Workflows, templates, layouts, assets, branding, and environment configuration | ||||||||||||||||||
| - **Recipient data.** Users, objects, tenants, and all associated data | ||||||||||||||||||
| - **Message history and logs.** Message logs, API logs, workflow run logs, and audit logs | ||||||||||||||||||
|
|
||||||||||||||||||
| For context on how Knock handles data during normal operation, see [data retention](/manage-your-account/data-retention). | ||||||||||||||||||
|
|
||||||||||||||||||
| ## What happens to account members | ||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Noting that this wraps in the TOC. We could update this and then one above to Data deletion and Account member deletion? Couldn't think of any other good options. |
||||||||||||||||||
|
|
||||||||||||||||||
| All members are removed from the account when it is deleted. Each member receives an email informing them that the account has been deleted. Learn more about [managing account members](/manage-your-account/managing-members). | ||||||||||||||||||
|
|
||||||||||||||||||
| ## How to delete your account | ||||||||||||||||||
|
|
||||||||||||||||||
| 1. Open your account settings in the Knock dashboard. | ||||||||||||||||||
| 2. Navigate to the **General** section. | ||||||||||||||||||
| 3. Find the **Delete account** option and follow the prompts to confirm. | ||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'm assuming this is correct -- I couldn't find your control changes. Do you have them staging somewhere? |
||||||||||||||||||
| 4. Enter your account slug to confirm the deletion. | ||||||||||||||||||
| 5. Confirm the deletion. Your account and all associated data will be permanently removed after 24 hours. | ||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are we going to show a confirmation modal/message? Wondering what "confirm the deletion" looks like. If there are any errors/issues, will we display a toast message informing them of the error and that the deletion wasn't successful? |
||||||||||||||||||
|
|
||||||||||||||||||
| <Callout | ||||||||||||||||||
| type="alert" | ||||||||||||||||||
| title="Note" | ||||||||||||||||||
| text="Account deletion is permanent and cannot be undone. Make sure you have exported or migrated any data you need before proceeding." | ||||||||||||||||||
|
Comment on lines
+45
to
+46
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I wonder if it's better to have this right above the How to header? I don't have a strong opinion on that, but might be more noticeable there?
Comment on lines
+45
to
+46
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I wonder if this would be more noticeable above the How to header? I'm not sure. |
||||||||||||||||||
| /> | ||||||||||||||||||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is it worth adding a note about historical records / logs here? I know we cover that in the section below, so might be overkill.