Prerequisites
Before you write code for a App, you should register a App. When you register a App, you select permissions for the app. These permissions dictate what the App can do. When you register an app, you also specify other settings, including which webhook events your App should receive. You can always change the settings for your App registration. For more information, see Registering a App and Modifying a App registration.
If you want your App to access repository and/or organization data, you need to install your App. For more information, see Installing your own App.
Writing code for a App
In order for your App to do something, you need to write code to add functionality to your App.
For tutorials about how to write code for a App, see:
- Quickstart for building Apps
- Building a App that responds to webhook events
- Building a "Login with " button with a App
- Building a CLI with a App
You can use the credentials from your App registration to make authenticated requests to 's APIs. For more information, see About authentication with a App.
During development, you will likely use your personal computer or codespace to run your App. You may need to make some modifications to your App registration during development:
If your app receives webhooks, you may want to use a webhook proxy URL to forward webhooks from to your computer or codespace. You will need to update the "Webhook URL" setting in your App registration to use your webhook proxy URL. For an example, see Building a App that responds to webhook events.
If your app uses the web application flow to authorize a user, you may want to update the "Callback URL" setting in your App registration to use a local callback URL. For an example, see Building a "Login with " button with a App.
Next steps
Once you write the code for your App, you should ensure that it follows best practices. If necessary, remember to update your App registration. If your App needs to run on a server instead of a user's device, deploy your app to your server. Finally, you can share your App with other users and organizations.
Follow best practices
Before deploying your App, make sure you follow best practices. For example, make sure that your App's credentials are secure. For more information, see Best practices for creating a App.
Update your App registration
If you changed the App registration for development, make sure you update the registration to use production-ready values. For example, if you used a webhook proxy URL for development, you should update the "Webhook URL" field to use the URL where you want your App to receive webhooks during production.
Deploy your App
Once you have written the code for your App, your code needs to run somewhere. If your app is a website or web app, you might host your app on a server like Azure App Service. If your app is a client-side app, it might run on a user's device.
Share your App
If you want to share your App with other users and organizations, you should make your App public. To make your App more discoverable, you can list it on Marketplace. For more information, see Sharing your App.