Support Centre

How do I invite a new user?

To invite a new user to your project you will need to navigate to the User Management page.Then click Invite New User:Enter their Name, Email and Company then choose their permissions.Once you are...

from the User Management topic

Assigning a user to a project

To assign a user to a project navigate to the overview of the project you would like to give that user permissions for and click Manage project assignments under Project Settings.Once inside the...

from the User Management topic

Deleting a user

p: If you don't want to permanently remove a user you can disable them instead. Navigate to the User Management page located under the Settings drop down menu. , Select the user you wish to remove...

from the User Management topic

Available User Permissions

Account Can add/edit/delete roles?, Can adjust account branding options?, Can change account settings (name, domain etc...)?, Can create account administrators?, Can manage account billing...

from the User Management topic

How to change your username

You can change your username at any time, however this will affect all accounts that you are invited to. Your main user account is managed via our single sign-on service, aTech Identity, and the...

from the User Management topic

Tracking Deployments

Codebase allows you to track deployments by sending a request to the application whenever you deploy your application. This will be stored within the repository object and displayed in the activity...

from the Tips & Tricks topic

Linking Commits with Tickets

One of the very useful features Codebase offers is the ability to update tickets from within a commit message.From within a commit message you can change the status of a ticket (thereby closing it),...

from the Tips & Tricks topic

Syntax highlighting in markdown

Codebase allows you to use markdown in various places such as ticket updates and notebook pages. Markdown is great because of its support of code blocks. We've tied this in with Codebase's powerful...

from the Tips & Tricks topic

Creating a ticket

To create a ticket, browse to the Overview of the project that you wish to add a ticket to and click the New Ticket button:Or click the New Ticket icon from the Tickets drop down from anywhere with...

from the Tickets topic

Updating a ticket

To update a ticket firstly browse to the ticket you want to update.There are a number of ways to get to a ticket, for example, if you can see the ticket in your project overview then you can simply...

from the Tickets topic

Project Groups

Projects can, optionally, belong to groups within your account to help you keep things more organised. ##API URLs Data Method URL All...

Project Users

Account administrators assign users to projects to grant them access or display their involvement with the project. ##API URLs Data Method URL ...

Commits

You can access a list of all commits within your repository for a specific branch and/or path. ##API URLs Data Method URL All commits...

Files

You can fetch a file in your repository using the API provided you know the commit ref and file path that you want to access. ##API URLs Data Method URL ...

Hooks

Repository hooks are HTTP requests which get made after Codebase has received a repository push. ## API URLs Data Method URL All hooks...

Branches

You can access a list of all branches for your repository. ## API URLs Data Method URL All branches on a repository GET ...

PHP - Upload a Ticket Attachment

The following code will upload a file to a ticket as a new attachment ```php $file_to_upload = array( 'ticket_attachment[attachment]'=>'@/path/to/file_to_upload.file', ...

PHP - Display Categories for a Project

The following code fetches all of the Ticket Categories for a project and populates the result into an array. ```php define('CBAUTH', 'accountName/userAccount:authToken');...

Discussions

Discussions in Codebase allow you do discuss project specific issues with other members of your team. ##API URLs Data Method URL All...

Code Examples

##Creating Records. If you want to create an object in Codebase, you can simply pass the object's XML definition to the appropriate URL. Throughout the API documentation, you will see 'API URL'...

Attachments

# This method is now deprecated. You should use [Uploading FIles](../uploading-files) with [Updating Tickets](updating-tickets) instead. You can attach/upload files to tickets to include a ticket...

Uploading Attachments

You can upload files to include with a ticket update or project file creation. If the uploaded image is detected as an image (GIF, JPG or PNG) we'll display it in the web interface. ##API...

File Storage

Codebase projects have an area for storing files. ##API URLs Data Method URL All files in a project GET /project/files ...

Ruby/Faraday - Add project file

So, you want to add a file to a project as described in [File Storage](../file-storage) and you're using Ruby and Faraday? This is a two step process, first of all we're going to upload the file,...

PHP - Backup GIT Repositories

The following code will download all GIT repositories from an account. ``` * */ define('API_URL', 'https://api3.codebasehq.com/'); define('API_USER', ''); define('API_PASSWD',...

Ruby/ Faraday - Trac to Codebase

Ruby script for importing Trac tickets saved as CSV's into CodebaseHQ - thanks to [Ian Dickinson](https://github.com/ephemerian/trac-to-codebase) for the code. ```ruby #!/usr/bin/env ruby # #...

Statuses, Priorities and Categories

Status, priorities and categories all come under the same heading of "property objects". All three can be assigned to tickets using their foreign key, however to do this, you need to know the IDs of...

Projects

A project is a core part of your Codebase account. Each project can contain repositories, tickets, milestones, wikis and many other objects. Projects are referenced throughout the application by...

Repositories

A repository has a large number of moving parts. Over time, you'll be able to access all of these using the API as well as the web interface. At present, you can access a list of all available...

Public Keys

When working with Git or Mercurial repositories, you need to connect to the Codebase system using SSH. To authenticate, your SSH request you need to add your [SSH public...

Watchers

Any user which participates in a ticket can choose to "watch" it. Each time a new update is posted all ticket watchers will be notified according to their notification preferences. When a ticket is...

Wiki

You can view all wiki pages using the API. At this time, wiki pages cannot be edited or added using the API. Using the methods below you can download an entire archive of your wiki content if...

Searching

The ticket system has a powerful and sophisticated searching system which allows users to easily find tickets quickly. The syntax for searching is quite simple once you get to know it, and of course,...

Activity Feeds

Most activities which you carry out within Codebase are logged to your activity feed so you can easily see what's been going on throughout your account or project. This activity feed data is...

Merge Requests

You can use the merge requests API to create and manipulate merge requests on a repository. You should be able to perform any interaction using the API that a user can from the web interface. ##...

User Management

You can invite users or view existing users and their current assignments through the API. ## API URLs Data Method URL Show currently...

Deployments

You can track deployments of individual repositories by simply sending a request to the API. Our codebase gem includes support for [Capistrano](http://capify.org), but there is no reason why you...

Milestones

Any ticket can be assigned to a milestone. Milestones can also belong to each other - milestones with a `parent-id` are child milestones. ##API URLs Data Method ...

API Documentation

Codebase offers a powerful API allowing you to easily work with all the data stored in your account. **We'd suggest reading the information below before you start exploring the rest of the API as...

Tickets and Milestones

Each project can contain any number of tickets. A ticket also belongs to a number of "property objects" - statuses, priorities or categories - the available objects are listed below and are...