GitLab

Create GitLab integration

Changed on

Link a project to a GitLab project. Kaneo generates the secret GitLab must send with each webhook; add the webhook in GitLab afterwards. Use the verify route first to confirm the token really reaches the project.

post/gitlab-integration/project/{projectId}

Request

  • Base URL
    https://cloud.kaneo.app/api
  • URL
    https://cloud.kaneo.app/api/gitlab-integration/project/{projectId}
  • Auth
    HTTP bearer

Path parameters

projectIdstring required

Request body

baseUrlstring uri required
accessTokenstring

Omit to keep the stored token only when the GitLab base URL is unchanged. A changed URL requires a new token.

tokenType'private' | 'bearer'

private sends the token in PRIVATE-TOKEN, which is what personal, project and group access tokens expect. bearer sends it in Authorization, for an OAuth2 token you already hold. Defaults to private.

projectPathstring required

Response

The stored integration

idstring required
projectIdstring required
baseUrlstring required

Root URL of the GitLab instance.

projectPathstring required

Full path of the linked project, nested groups included.

tokenType'private' | 'bearer' required
maskedAccessTokenstring required

First and last characters of the stored token, only returned to callers with workspace:manage_settings.

webhookUrlstring

Where GitLab should POST events for this project.

webhookSecretstring

Only returned to callers with workspace:manage_settings, so the value can be pasted into GitLab.

branchPatternstring
commentTaskLinkOnGitlabIssueboolean

When on, Kaneo comments a link back to the task on each issue opened in GitLab. Issues Kaneo creates from tasks are not commented on.

isActiveboolean nullable required
createdAtstring date-time required
updatedAtstring date-time required

Changes

  • c9984766c765Revision changes
    • info

      added the non-success response with the status

  • c7b8a842601bRevision changes
    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • breaking

      removed the media type text/plain for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status