Codebase API Documentation

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 available as RSS or XML. All RSS & XML data includes full URLs to any destinations with your Codebase account.

The API will always return the last 20 entries from the feed. Pass the page param to fetch older entries.

API URLs

You can use any of the API urls below to retrieve your activity feed data.

Data Method URL
Account Feed GET /activity(?raw=true&since=2014-09-26 17:26:47 +0100)
Feed for specific project GET /project/activity(?raw=true&since=2014-09-26 17:26:47 +0100)

If a restricted user requests the account feed, they will only be able to view entries from projects they are assigned and have read access to.

Object Properties

The XML output below shows the properties which are returned by default when accessing project details.

GET /activity

<events>
  <event>
    <title>Adam Cooke created project Widgets</title>
    <type>project</type>
    <timestamp>Tue, 20 Oct 2009 21:02:01 +0000</timestamp>
    <html-title>&lt;a href=&quot;https://account.codebasehq.com/users/adam&quot;&gt;Adam Cooke&lt;/a&gt; &lt;span class='action'&gt;created project&lt;/span&gt; &lt;a href=&quot;https://account.codebasehq.com/widgets&quot;&gt;Widgets&lt;/a&gt;</html-title>
    <html-text>There is no overview for this project</html-text>
  </event>
</events>
  • title plain text title of the activity event
  • type type of entry. See list below.
  • html-title HTML version of the title as rendered in the web interface & RSS feed.
  • html-text HTML version of the text as rendered in the web interface & RSS feed.

Event Types (and their properties, if requested)

There are a number of event types which you may see in your activity feed. In the Codebase interface, these are colour coded (the colour is provided in brackets below).

  • comment - when a user published a comment to a commit or discussion topic (dark blue)
    • content - the comment
    • commit_ref - the commit reference
    • repository_permalink - the permalink of the project
    • project_permalink - the permalink of the project the comment belongs to
    • project_name - the name of the project the comment belongs to
  • commit - when a commit is added to a repository without a push (via. sync, mercurial or manual scans) (light blue)
  • deployment - when you deploy your repositories (brown/orange)
  • named_tree - when a branch or tag is added, edited or deleted (light blue)
  • project - when a project is created or deleted (yellow)
  • push - when you push to your repository (html-text includes a list of commits within the push) (light blue)
  • ticketing_milestone - when a milestone is added or status changed (purple)
    • name - the name of the milestone
    • start_date - the date the milestone starts
    • identifier - the unique identifier for the milestone
    • project_permalink - the permalink of the project the milestone belongs to
    • project_name - the name of the project the milestone belongs to
  • ticketing_note - when a new note is added to a ticket. Includes attachments and commit ticket updates (green)
    • number - the number assigned to the ticket by Codebase
    • subject - the subject of the ticket
    • content - the contents of the update
    • changes
    • time_added
    • project_permalink - the permalink of the project the wiki belongs to
    • project_name - the name of the project the wiki belongs to
    • verb
    • source
    • source_ref
  • ticketing_ticket - when a ticket is created (green)
    • subject - the subject of the ticket
    • number - the number assigned to the ticket by Codebase
    • project_permalink - the permalink of the project the ticket belongs to
    • project_name - the name of the project the ticket belongs to
    • assignee - the name of the person assigned to the ticket
    • priority - the name of the priority
    • source
    • source_ref
  • wiki_page - when a wiki page is created or updated (excluding all minor edits) (grey)
    • name - the name of the wiki
    • identifier - the unique identifier for the sprint
    • project_permalink - the permalink of the project the wiki belongs to
    • project_name - the name of the project the wiki belongs to
  • sprint_creation - when a sprint is created (orange)
    • name - the name of the sprint
    • start_date - the date the sprint starts
    • end_date - the date the sprint ends
    • ticket_count - the number of tickets the sprint consists of
    • project_permalink - the permalink of the project the sprint belongs to
    • identifier - the unique identifier for the sprint
  • sprint_ended - when a sprint ends (orange)
    • name - the name of the sprint
    • remaining_tickets - the number of remaining tickets at the end of the sprint
    • velocity - the average number of completed tickets per day
    • project_permalink - the permalink of the project the sprint belongs to
    • identifier - the unique identifier for the sprint
    • project_name - the name of the project the sprint belongs to