VCS Integrations

Setting up the Clubhouse GitLab Integration

With the Clubhouse GitLab integration you can link Stories to commits, branches and pull requests, as well as move Stories across your workflow.

Following these instructions, you can configure the Clubhouse GitLab integration to work with your GitLab account.

Note: This integrates with and self-managed GitLab installations using version 9.5 or higher. 

For self-managed GitLab users: Our GitLab integration needs to talk to the API of your self-managed GitLab install to properly process some event payloads. It determines the address of the API using the URLs included in the webhook payloads, and that address needs to be publicly accessible for us to reach it. Non-resolvable hostnames will cause the integration to not work correctly. 

Setting up the integration in Clubhouse

Only Admins and Owners can activate this integration in Clubhouse.

In the Clubhouse app, click the Gear icon in the upper right corner, click Integrations, and then click GitLab.

Click the Slider to enable, then copy the GitLab Payload URL and open your GitLab account.



In GitLab, choose specific Projects that you want to send data to Clubhouse, or if your plan supports Group Webhooks, you can send data from every Project in the Group.

From the Project page (or Group page), click Settings > Integrations, then paste the GitLab Payload URL into the Integrations URL field.



Next, check that the correct events will be sent to Clubhouse.

Click the checkbox for:

  • Push Events
  • Comments
  • Merge request events

 You may optionally include Confidential Comments.




If you are not using GitLab's Group webhooks, be sure that you've added the GitLab Payload URL to the Integrations Settings for each Project that should send data to Clubhouse.


Add user(s) email address as public in GitLab

In order for Clubhouse's event handler to determine which GitLab user performed certain actions in Clubhouse, we match the email from GitLab payload to that of the Clubhouse user. Ensure that the public email in Settings (under user icon) > Main Settings is set to the appropriate email for the user in Clubhouse.





The last step is to place a personal access token from GitLab into Clubhouse. You may use an individual user's token, but it is recommended that you create a bot user in GitLab.



Create a GitLab Bot User

1. Create a new user on in your organization. Consider using a name that signifies this user connects GitLab to Clubhouse, like 'Clubhouse Bot'.

2. In GitLab, invite your bot user to the Projects that you want Clubhouse to access, and grant that user Developer permissions.

3. Log in with the bot user account and open the User Settings.

4. Generate a personal access token scoped to have api access




5. Copy the personal access token and paste it into the API Access Token field in the GitLab integration pane. Click Update API Access Token to save the token value.





Have more questions? Submit a request