Webhook format v5

The project webhook allows your application to listen for activity in your project as HTTP POST requests. It’s possible to add multiple webhooks per project on the Webhooks page in project settings.

Tracker will send POST requests to the URL that you specify here every time a story activity occurs (e.g., when someone creates or edits a story, adds a comment, or changes a story’s state).

The POST body of these requests will contain JSON describing the activity, as well as the affected story, in the exact same format as the API activity resource The only difference in this case is that there is only one activity, so an activity’s element will not be present. This is an example of a request that your URL will receive when Darth Vader accepts a story:

{
 "occurred_at": 1382568826000,
 "highlight": "accepted",
 "primary_resources": [
  {
   "story_type": "feature",
   "name": "Reactor leak reported in Detention Block AA-23",
   "url": "http:///story/show/563",
   "id": 563,
   "kind": "story"
  }
 ],
 "changes": [
  {
   "story_type": "feature",
   "name": "Reactor leak reported in Detention Block AA-23",
   "new_values": {
    "accepted_at": 1382568827000,
    "before_id": 6024,
    "after_id": 559,
    "current_state": "accepted",
    "updated_at": 1382568826000
   },
   "original_values": {
    "accepted_at": null,
    "before_id": 6643,
    "after_id": 565,
    "current_state": "delivered",
    "updated_at": 1382568825000
   },
   "id": 563,
   "change_type": "update",
   "kind": "story"
  }
 ],
 "message": "Darth Vader accepted this feature",
 "project_version": 1037,
 "performed_by": {
  "name": "Darth Vader",
  "initials": "DV",
  "id": 101,
  "kind": "person"
 },
 "guid": "99_1037",
 "project": {
  "name": "Death Star",
  "id": 99,
  "kind": "project"
 },
 "kind": "story_update_activity"
}

The format of the JSON feed is the same as the API activity feed (see Interpreting an Activity Item). To experiment with the activity webhook, and see the notification requests, we recommend using RequestBin. Make a RequestBin, enter the bin’s URL in the Webhook URL in Tracker (on the project Integrations page), then watch that RequestBin URL as you make changes to stories in your project.

To set up an project webhook in Tracker:

  1. Click the Settings tab in your project, then choose Webhooks in the sidebar.
  2. Paste in your URL, choose API version v5, then click Add.
Next
Migrating webhooks to API v5