GitLab

• Mintlify uses access tokens to pull information from GitLab.
• GitLab uses webhooks to notify Mintlify when you make changes, which enables preview deployments for merge requests.

​

Set up the connection

1

Select GitLab as your provider

On the Git Settings page, select Connect to GitLab and click Continue.

2

Download your content

If you already have a GitLab repository with your documentation, you can skip the download and click Continue setup directly.

If your documentation is hosted by Mintlify, download it as a zip file.

• Create a new repository in GitLab.
• Extract the zip contents.
• Push the contents to your repository.

Click Continue setup to proceed.

3

Find your project ID

In your GitLab project, navigate to Settings > General and locate your Project ID.

4

Generate an access token

Navigate to Settings > Access Tokens and select Add new token.Configure the token with these settings:

• Name: Mintlify
• Role: Maintainer (required for private repos)
• Scopes: api and read_api

Click Create project access token and copy the token.

If Project Access Tokens are not available, you can use a Personal Access Token instead. Note that Personal Access Tokens expire and must be updated.

5

Connect your repository

Back in the setup wizard, fill in the following fields:

• GitLab instance URL: Leave blank for gitlab.com, or enter your self-hosted instance URL (for example, https://gitlab.your-domain.com). Your instance must be publicly accessible for Mintlify to reach it.
• Project ID: The project ID from your GitLab project settings.
• GitLab deployment token: The access token you generated.
• Branch: Select the branch to deploy your documentation from.

Click Connect.

​

Update an existing connection

​

Create the webhook

1

Add new webhook

1. In GitLab, navigate to Settings > Webhooks.
2. Click Add new webhook.

2

Set up URL and webhook

Name the webhook Mintlify.In the URL field, enter the endpoint https://leaves.mintlify.com/gitlab-webhook.

3

Get webtoken

In your Mintlify dashboard, click Show Webtoken. Copy the webtoken.

4

Paste webtoken

In GitLab, paste the webtoken from your Mintlify dashboard in the Secret token field.

5

Select events

Select the following events to trigger the webhook:

• Push events (All branches)
• Merge requests events

6

Verify the webhook

You should see the following settings after configuring the webhook:

• Name: Mintlify
• URL: https://leaves.mintlify.com/gitlab-webhook
• Secret token: The webtoken from your Mintlify dashboard
• Events: Push events (All branches) and Merge requests events

Add the webhook.

7

Test the webhook

After you create the webhook, click the Test dropdown. Click Push events to send a sample payload. If the test returns Hook executed successfully: HTTP 200, you configured the webhook correctly.