Concepts

upcoach programs consist of blocks, with numerous blocks such as tasks, events, and smart docs falling under the Core Features category. Our aim with the Developers Portal is to enable third-party developers to create their own blocks. Thus, we want to explain the block approach and its relationship with the application.

Think of the blocks as connector URLs embedded within iframes. Let's assume we have a todo application, and the address "example.org/todos" is where we list the user's todos. In the Developer Portal, we create a block named "Todo Listing" and add "example.org/todos" as the connector URL. When accessed on the upcoach platform, this URL will be displayed, and upcoach will automatically send various data, such as active user information and program details, to the application. This empowers the application developer to offer a personalized experience to users. For instance, they can present a customized todo list for each user. We will delve into this data transfer and security flow in more detail during the development phase.

Furthermore, an application can have multiple blocks. This means you can separate different screens with different purposes into distinct blocks and define them with separate connector URLs. For example, for a todo application, one block can list the user's todos, while another block can provide a report related to the user's todos.

Using the Help URL structure, you can provide users with help documentation to make using your application more straightforward.

Through the Settings URL structure, you can offer application-level settings to users rather than block-specific settings. For instance, if you want to provide a customizable category structure in your todo application, you can offer these settings to users through the Settings URL structure.

upcoach webhooks will transmit various information to your application. The most crucial webhooks among them are the "install" and "uninstall" webhooks. With the "install" webhook, when a user installs your application to their organization, we send you a token via webhook that allows you to make API queries related to that organization. On the other hand, the "uninstall" webhook informs you when a user removes your application from their organization. This way, when a user uninstalls your application, you can perform necessary data deletion actions for that user.