Skip to content

Conversation

@kovalev-stripe
Copy link
Contributor

@kovalev-stripe kovalev-stripe commented Sep 3, 2025

Summary

Add the onboarding post install action type (that is used to direct users to complete onboarding tasks before using an app) to the JSON schema.

{
"const": "settings"
"oneOf": [
{ "const": "modal" },
Copy link
Contributor Author

@kovalev-stripe kovalev-stripe Sep 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To be honest, I think it was a mistake to choose modal as one of the post_install_actions for the onboarding flow, because it doesn't explicitly imply the onboarding flow, and probably we should use "type": 'onboarding' instead:

"post_install_action": {
	"type": "onboarding"
}

This would abstract away the implementation details of how the Onboarding view is displayed (modal window, separate page/route, etc) in the Dashboard, and will be aligned with how the post_install_action for the Settings view is configured.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree with what you said, back then we were just trying to match the action with the viewport for consistency which at the time was named "modal". We could make the change on the backend to also reflect "onboarding" instead

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have updated the initial commit so that we define onboarding instead of modal post-install action.
Could you please re-approve?

@kovalev-stripe kovalev-stripe changed the title Add modal post install action type to JSON schema Add onboarding post install action type to JSON schema Sep 4, 2025
@kovalev-stripe kovalev-stripe force-pushed the sasha/modal-post-install-action branch from 4702e35 to 1b34eae Compare September 4, 2025 09:10
@kovalev-stripe kovalev-stripe force-pushed the sasha/modal-post-install-action branch from 1b34eae to 89d4b40 Compare September 4, 2025 09:11
@kovalev-stripe kovalev-stripe merged commit af6b174 into main Sep 4, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants