Hosted App: Install

Users who approve your app will be able to "install" the app on their devices.
If your app has a configuration item, users will set it during installation.
For example, if it was a hosted app that says "Notify Slack if any of the obniz in your account goes offline", the user would first approve the app and install it on a device called obnizID XXXX-XXX and then install it on another device called YYYY-YYY for a total of 2 installations.


Getting Installation Information in the App Token

You can get information about installed apps using only the app token, not the OAuth token for each user.

Development of database-free web services.

With this installation, you can leave the management of OAuth and configuration information for each user in the database to obniz cloud instead of your own server.

All the users of your app will be able to get all the information that they have installed and set up at once and run your app. This allows you to create an app with the following flow

  1. get installation information from obniz cloud by API using app token when the program is launched on server
    Run the app for each installation information.
  2. dynamically add/remove apps with webhooks as users install/uninstall
  3. scale out if there are not enough server machines, and vice versa, reduce if there are too many


Webhook lets you know what users are doing to your Spp.


In the App settings screen, there is an item called webhook.
Fill in the URL you want to receive the webhook in this part, and the webhook will be done with the POST method


The webhook is a POST method and the body is a json and the format is as follows.

  type: 'install.create'
  • type: key of what prompted this webhook.
  • data: Data based on type.

The type can be one of the following

  • oauth.create
    Your user has approved your App
  • oauth.delete
    User has removed your App authorization.
  • install.create
    The user has installed your App
  • install.update
    A user has changed your App settings.
  • install.delete
    A user has uninstalled your App.

About Retry

Even if the response to Webhook is not 200 series, we do not retry.