Incoming Webhooks

Send real-time data to Jixee.

Incoming Webhooks are a simple way to create and update tasks or post version control data into Jixee. They make use of normal HTTP requests with a JSON payload, which includes the body and a few other optional details described later.

In order to use the webhook API you must go to Settings->API and retrieve your unique webhook URL. Here is a sample webhook URL: https://jixee.me/main/webhooks?token=c5397dbe4e3debafa2bbc13f2dddd431408a34a9

Jixee webhooks already support several third party integrations. Visit our support page to learn what integrations are already supported.

Common JSON Responses

JSON Response Header Code Description
status: ok 200 successful request
message: 401,500,403,400,404 information about why a request may have failed

Create Task Webhook

This webhook allows you to create a task in Jixee. Simply POST to the webhook and your task will be created in real-time.

Example POST

{
"action": "create",
"project_prefix": "jix",
"board_name": "Development",
"title": "Release Version 1",
"requestor": {"name": "john smith", "email":"john@jixee.me"},
"assignee": {"email": "joe@jixee.me"},
"milestone": true,
"epic": false,
"status":"o"
}            

POST Fields

Field Example Type
* action "create" string
* project_prefix "jix" string
* board_name "Backlog" string
* title "Task 1" string
* requestor {"name":"John Smith", "email": "john@jixee.me"} * Note email is optional object
assignee {"email": "joe@jixee.me"} object
milestone TRUE boolean
epic FALSE boolean
status "o","i", or "c" (open, in-progress, or complete) string
type "Feature" string
priority "Trivial", "Minor", or "Critical" string
difficulty "Easy", "Medium", or "Hard" string
planned_start_date YYYY-MM-DDTHH:mm:ss.sssZ ISO 8601 Extended Format
due_date YYYY-MM-DDTHH:mm:ss.sssZ ISO 8601 Extended Format
estimated_completion_time 3600 number (seconds)
actual_completion_time 2800 number (seconds)
description "Hello World!" string
tags "tag1,tag2,tag3" string

* indicates a required field.

Additional JSON Body Response

JSON Response Example Description
task_id jix-1001 task_id for the newly created task

Update Task Webhook

This webhook allows you to update a task in Jixee. Simply POST to the webhook and your task will be updated in real-time.

Example POST

{
"action": "update",
"task_id": "jix-1860",
"requestor": {"name": "john smith", "email":"john@jixee.me"},
"assignee": {"email": "joe@jixee.me"},
"title": "Task 1 Updated",
"status":"c",
"type":"Enhancement",
"description":"task has been completed"
}            

POST Fields

Field Example Type
* action "update" string
* task_id "jix-1001" string
* requestor {"name":"John Smith", "email": "john@jixee.me"} * Note email is optional object
assignee {"email": "joe@jixee.me"} object
title "Task 1" string
status "o","i", or "c" (open, in-progress, or complete) string
type "Feature" string
priority "Trivial", "Minor", or "Critical" string
difficulty "Easy", "Medium", or "Hard" string
planned_start_date YYYY-MM-DDTHH:mm:ss.sssZ ISO 8601 Extended Format
due_date YYYY-MM-DDTHH:mm:ss.sssZ ISO 8601 Extended Format
estimated_completion_time 3600 number (seconds)
actual_completion_time 2800 number (seconds)
description "Hello World!" string
tags "tag1,tag2,tag3" string

* indicates a required field.

Version Control Webhook

This webhook allows you to update version control data for a task. Simply POST to the webhook and your task will be updated in real-time, whether it is from a hosted instance of version control or a third party service.

Example POST

{
"action": "version",
"task_id": "jix-1860",
"commit_id": "4b6bce3637677f743572a9d188f5eb180e51fe86",
"message": "[title:Fixes 504 error] [status:i] [type:Bug] [priority:Critical] [difficulty:Medium] [planned_start_date:12/15/14] [due_date:02/23/2013] [assignee:joe@jixee.me]",
"timestamp": "2014-09-11T22:28:04.192Z",
"committer": {"name": "john smith"},
"url": "http://yoursite.com/commits/view/53r4jn2",
"repository": "your-awesome-repo",
"branch": "twigs"
}            

POST Fields

Field Example Type
* action "version" string
* task_id "jix-1011" string
* commit_id "4b6bce3637677f743572a9d188f5eb180e51fe86" string
* timestamp YYYY-MM-DDTHH:mm:ss.sssZ ISO 8601 Extended Format
* committer {"name":"John Doe", "email": "john.doe@a.com"} * Note email is optional object
message [title:Fixes 504 error] [status:i] [type:Bug] [priority:Critical] [difficulty:Medium] [planned_start_date:12/15/14] [due_date:02/23/2013] [assignee:joe@jixee.me] string
url "http://yoursite.com/commits/view/53r4jn2" string
repository "repo-depot" string
branch "master" string

* indicates a required field.

Additional JSON Body Response

JSON Response Example Description
extra_message Any extra information about a commit. For example, if updating a task failed via a commit message.

Note: You can update various properties of a task via a commit message. To learn what values can be updated via the message property, please read this support article.

Outgoing Webhooks

Receive real-time data from Jixee.

Outgoing Webhooks are a simple way to subscribe to key events that take place within Jixee. They make use of normal HTTP requests with a JSON payload.

In order to use the webhook API you must go to Settings->API and assign the event and url you will be listening on for that event.

Jixee webhooks already support several third party integrations. Visit our support page to learn what integrations are already supported.

header type: application/json


Common JSON Responses

Values Description
action Event that occured
unix_epoch Timezone free "seconds since epoch" of the time the message was sent
payload Concentrated data about the event that occured

Task Created

Occurs each time a task is created.

Example Receipt

{
  "action":"task_created",
  "unix_epoch":1435341774,
  "payload":
  {
    "id":"jix-1",
    "actual_completed_time":{"weeks":null,"days":null,"hours":null,"minutes":null},
    "board_name":"Backlog",
    "description":"Add sources to the account. Escape the rival company undetected? Profits..",
    "difficulty":"medium",
    "duedate":"06/29/2015",
    "estimated_completed_time":{"weeks":null,"days":null,"hours":"7","minutes":null},
    "epic":false,
    "owner":{"email":"admin@gmail.com","first_name":"Admin","last_name":"User","profile_pic":null},
    "planned_start_date":"06/24/2015",
    "priority":"critical",
    "project_name":"The Johnson Account",
    "create_date":"2015-06-26T18:02:54.790Z",
    "status":"open",
    "tags":"UI,SCRIPTING",
    "title":"New Sources",
    "type":"Improvement"
  }
}

Task Updated

Occurs each time a task is updated.

Example Receipt

{
  "action":"task_updated",
  "unix_epoch":1435342260,
  "payload":
  {
    "id":"jix-1",
    "actual_completed_time":{"weeks":null,"days":null,"hours":null,"minutes":null},
    "board_name":"Backlog",
    "description":"Caught by rivals. You never knew me. This message will self destruct in x seconds.",
    "difficulty":"hard",
    "duedate":"07/03/2015",
    "estimated_completed_time":{"weeks":null,"days":null,"hours":"7","minutes":null},
    "epic":false,
    "owner":{"email":"admin@gmail.com","first_name":"Admin","last_name":"User","profile_pic":null},
    "planned_start_date":"06/24/2015",
    "priority":"trivial",
    "project_name":"The Johnson Account",
    "create_date":"2015-06-26T18:02:54.790Z",
    "status":"open",
    "tags":"UI,SCRIPTING",
    "title":"New Sources",
    "type":"Improvement"
  }
}

Task Deleted

Occurs each time a task is deleted.

Example Receipt

{
  "action":"task_deleted",
  "unix_epoch":1435342815,
  "payload":{
    "id":"jix-1",
    "actual_completed_time":{"weeks":null,"days":null,"hours":null,"minutes":null},
    "board_name":"Backlog",
    "description":"Caught by rivals. You never knew me. This message will self destruct in x seconds.",
    "difficulty":"hard",
    "duedate":"07/03/2015",
    "estimated_completed_time":{"weeks":null,"days":null,"hours":"7","minutes":null},
    "epic":false,
    "owner":{"email":"admin@gmail.com","first_name":"Admin","last_name":"User","profile_pic":null},
    "planned_start_date":"06/24/2015",
    "priority":"trivial",
    "project_name":"The Johnson Account",
    "create_date":"2015-06-26T18:02:54.790Z",
    "status":"open",
    "tags":"UI,SCRIPTING",
    "title":"New Sources",
    "type":"Improvement"
  }
}

Rate Limits

The Jixee API and all integrations are subject to rate limiting.

Webhook Posting

In general we allow applications that integrate with Jixee's incoming webhooks to send no more than 500 requests per hour.

If your integration exceeds the rate limit, Jixee will start returning a HTTP 401 API Rate Limit Exceeded error, a X-Rate-Limit-Limit header containing your rate limit per hour, a X-Rate-Limit-Remaining header containing the amount of requests remaining and a X-Rate-Limit-Reset header containing the seconds until a rate limit reset. Continuing to send requests after being rate limited runs the risk of having your application permanently banned.

Increasing Your Rate Limit

If you require an increase in your rate limit please contact us. We will review your requirements and determine if you are eligible for our whitelist.

API Abuse

We reserve the right to rate limit other functionality to prevent abuse, spam, denial-of-service attacks, or other security issues.

API

Using our API is another way you can add data to Jixee. This allows you to implement your own tools and methods outside the Jixee interface. Simply use your API token and make a request.

https://jixee.me/main/api/upload/attachment?token={API_TOKEN}


You can also add the API token to the body of the request(where applicable)

https://jixee.me/main/api/upload/attachment

Attachments (upload/attachment)

Attach a file to a task.

HTML POST Example

              
<form id="jixee" method="post" action="https://jixee.me/main/api/upload/attachment?token=755363e07dbed16d554c151a69efdbff85d40b75" enctype="multipart/form-data">
  <input type="file" name="file" accept="image/*"/>
  <input type="hidden" name="task_id" value="jix-4694">
  <input type="hidden" name="email" value="owner@jixee.me">
</form>
<button type="submit" form="jixee" value="Submit">Submit</button>
              
            

POST Fields

* indicates a required field.

Field Example Type
token "1ah4hg8dhnm87" string
* task_id "jix-1011" string
* file file
email "user@email.com" string

If you'd like the activity and notifications to reflect a user, enter the email that matches the user in your Jixee account.