This API exposes basic data about the user's site and the app installed in it, as based on the user's authentication token.
When you provide the authentication token, you will receive identifying information for the user's site and the app instance parameters.
The primary identifier returned is the App Instance ID - the unique identifier of the app within the website. Using the App Instance ID, you can retrieve data about the site that installed the app (e.g., locale) and data about the app installed (e.g., current paid plan).
Deprecation Notice: This parameter will be removed on March 30, 2023. Use copiedFromTemplate instead.;
Retrieves data about the installation of your app on the user's website. The ownerInfo object requires the Read Site Owner Email permission scope. If the permission is not requested, ownerInfo is not returned.
Permission Scopes
For app development, you must have one of the following permission scopes:Syntax
When you sign up for the App Installed webhook, you will receive this notification when your app is installed on a site
Event Body
When you sign up for the App Removed webhook, you will receive this notification when your app is uninstalled from a site
Event Body
When you sign up for the Paid Plan Purchased webhook, you will receive this notification when a site owner purchases a paid plan
Event Body
When you sign up for the Paid Plan Changed webhook, you will receive this notification when a user changes the app’s paid plan (to another paid plan)
Event Body
When you sign up for the Paid Plan Auto-Renewal Cancelled webhook, you will receive this notification when a user cancels their paid plan. (The user will remain a paying user until the plan expires)