Skip to main content

Integrations

Abstract

Connect your Git provider account to Bitrise and use SSH keys to allow Bitrise to access your code during a build. You can also use a VPN to connect to your repository. Use Webhooks to notify Bitrise about code events.

Once your Bitrise account and your Workspaces are set up, the next step is to make sure that you can connect your Bitrise account to other services and that Bitrise can access your code during a build.

Connecting to services

Each Bitrise user can connect their account to a GitHub, Bitbucket, and GitLab account. Doing so ensures that you can easily and quickly add new apps from repositories at those Git provider accounts without having to manually enter the URL: Connecting your GitHub/GitLab/Bitbucket account to Bitrise.

If you ever develop iOS apps, you need to be able to connect to Apple services. On Bitrise, you can connect to an Apple account via either an Apple ID or by API key authentication: Apple services connection.

An important part of communicating with other services is the service credential user. It is a user with a connected Git account which is used to, for example, send status reports back to the Git provider: The service credential user.

Accessing your code during a build

Bitrise needs to be able to access and clone your repositories during the build process. We recommend using SSH keys for authentication for private apps. You can automatically generate and add SSH keys to your Git account during the process of adding a new app, or at any point in the App settings menu: Configuring SSH keys.

Public apps

Public apps can't have SSH keys as they do not require authentication and always use HTTP URLs.

You can use repositories with submodules or private repo dependencies, too. In this case we recommend adding the same SSH key to all repository dependencies, or use a machine user: Apps with submodules or private repo dependencies.

You might need to use a VPN to be able to connect to your code. Bitrise allows you to do this and we have examples for connecting with several different VPN services: Connecting to a VPN during a build.

Webhooks

Webhooks are an important part of using Bitrise: an incoming webhook set up in your repository notifies Bitrise about code events (such as pushes, tags, and pull requests) and allows automatically triggering builds. Incoming webhooks can be set up at a number of different Git providers, both manually and automatically: Adding incoming webhooks.

Outgoing webhooks configured on Bitrise allows you to send build event notifications to any service. You can configure custom headers for the webhook payload, and check the deliveries of the webhooks on the web interface: Adding outgoing webhooks.

In this section:

A Workspace is an environment that allows you to manage your Bitrise apps and the team members working on the apps. You can create multiple Workspaces, and you can be invited to Workspaces by other Bitrise users. To be able to add apps and run builds, you either need to be part of a Workspace, or you have to be an outside contributor on an app's team.

An app on Bitrise represents a Git repository that stores source code and has been connected to Bitrise to be able to run builds on it. As such, a Bitrise app isn't necessarily an actual application: it's just the code on which you run builds with Bitrise.

appappapp