Integrations API
Example Request
POST /api/v1/integrations
Example CURL command
curl "https://company.aha.io/api/v1/integrations" -d '{"integration":{"service_name":"zendesk","enabled":true}}' -X POST \
-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
Request
Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76 Content-Type: application/json Accept: application/json
{
"integration": {
"service_name": "zendesk",
"enabled": true
}
}
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"integration": {
"id": "6733663266671044288",
"service_name": "zendesk",
"name": "Zendesk",
"enabled": true,
"callback_token": "9614adbed80563e5f46c0290ce0fe23b61ae96a4fc5a15b4ff5d2ae1c57b98ff",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"url": "http://company.aha.io/integrations/6733663266671044288",
"resource": "http://company.aha.io/api/v1/integrations/6733663266671044288",
"owner": {
"type": "Account",
"id": "303742481",
"url": "http://company.aha.io/account/303742481",
"resource": "http://company.aha.io/account/303742481"
}
}
}
Example Request
GET /api/v1/integrations
Example CURL command
curl -g "https://company.aha.io/api/v1/integrations" -X GET \ -H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \ -H "Content-Type: application/json" \ -H "Accept: application/json"
Request
Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76 Content-Type: application/json Accept: application/json
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"integrations": [
{
"id": "163322775",
"name": "Activity webhook",
"service_name": "audit_webhook",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "79015308",
"name": "Salesforce",
"service_name": "salesforce",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "828392279",
"name": "Security webhook",
"service_name": "security_webhook",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "916415359",
"name": "Slack [to Aha!]",
"service_name": "slack_commands",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "938531265",
"name": "Slack [to Aha!]",
"service_name": "slack_commands",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "241856910",
"name": "Trello",
"service_name": "trello",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "390243673",
"name": "Zendesk",
"service_name": "zendesk",
"created_at": "2019-01-01T00:00:00.000Z"
}
],
"pagination": {
"total_records": 7,
"total_pages": 1,
"current_page": 1
}
}
Parameters
| Name | Description |
|---|---|
| product_id * | Numeric ID, or key of the product to create an integration for |
Example Request
POST /api/v1/products/PRJ1/integrations
Example CURL command
curl "https://company.aha.io/api/v1/products/PRJ1/integrations" -d '{"integration":{"service_name":"zendesk","enabled":true}}' -X POST \
-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
Request
Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab Content-Type: application/json Accept: application/json
{
"integration": {
"service_name": "zendesk",
"enabled": true
}
}
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"integration": {
"id": "6733663267523974164",
"service_name": "zendesk",
"name": "Zendesk",
"enabled": true,
"callback_token": "4119669cd1431994d661a03369a5044848a0a802987f5236f61ded8823252182",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"url": "http://company.aha.io/integrations/6733663267523974164",
"resource": "http://company.aha.io/api/v1/integrations/6733663267523974164",
"owner": {
"type": "Project",
"id": "131414752",
"url": "http://company.aha.io/projects/PRJ1",
"resource": "http://company.aha.io/projects/PRJ1"
}
}
}
Parameters
| Name | Description |
|---|---|
| product_id * | Numeric ID, or key of the product to get integrations for |
Example Request
GET /api/v1/products/PRJ1/integrations
Example CURL command
curl -g "https://company.aha.io/api/v1/products/PRJ1/integrations" -X GET \ -H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \ -H "Content-Type: application/json" \ -H "Accept: application/json"
Request
Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab Content-Type: application/json Accept: application/json
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"integrations": [
{
"id": "36231792",
"name": "GitHub Issues",
"service_name": "github_issues",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "204584239",
"name": "Jira",
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "207648948",
"name": "Jira",
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "322044925",
"name": "Jira",
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "342659513",
"name": "Jira",
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "413207847",
"name": "Jira",
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "583937884",
"name": "Jira",
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "202598724",
"name": "Jira via Connect",
"service_name": "jira_connect",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "550349479",
"name": "Jira via Connect",
"service_name": "jira_connect",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "31907509",
"name": "Rally",
"service_name": "rally",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "868040294",
"name": "Rally",
"service_name": "rally",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "846899991",
"name": "Azure DevOps Services",
"service_name": "tfs",
"created_at": "2019-01-01T00:00:00.000Z"
},
{
"id": "945767377",
"name": "Trello",
"service_name": "trello",
"created_at": "2019-01-01T00:00:00.000Z"
}
],
"pagination": {
"total_records": 13,
"total_pages": 1,
"current_page": 1
}
}
Parameters
| Name | Description |
|---|---|
| product_id * | Numeric ID, or key of the product to retrieve an integration for |
| service_name * | Numeric ID of the integration to retrieve |
Example Request
GET /api/v1/products/PRJ1/integrations/204584239
Example CURL command
curl -g "https://company.aha.io/api/v1/products/PRJ1/integrations/204584239" -X GET \ -H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \ -H "Content-Type: application/json" \ -H "Accept: application/json"
Request
Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab Content-Type: application/json Accept: application/json
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"integration": {
"id": "204584239",
"service_name": "jira",
"name": "Jira",
"enabled": true,
"callback_token": "22b7893e7fa1c4c60847090f78fbf0ec",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"url": "http://company.aha.io/integrations/204584239",
"resource": "http://company.aha.io/api/v1/integrations/204584239",
"owner": {
"type": "Project",
"id": "131414752",
"url": "http://company.aha.io/projects/PRJ1",
"resource": "http://company.aha.io/projects/PRJ1"
}
}
}
GET /api/v1/products/:product_id/integrations/:service_name
Get a specific integration by service name
DEPRECATED: pass :integration_id rather than :service_name to identify the integration.
Parameters
| Name | Description |
|---|---|
| product_id * | Numeric ID, or key of the product to retrieve an integration for |
| service_name * | Service name of the integration to retrieve |
Example Request
GET /api/v1/products/PRJ1/integrations/jira
Example CURL command
curl -g "https://company.aha.io/api/v1/products/PRJ1/integrations/jira" -X GET \ -H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \ -H "Content-Type: application/json" \ -H "Accept: application/json"
Request
Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab Content-Type: application/json Accept: application/json
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"integration": {
"id": "204584239",
"service_name": "jira",
"name": "Jira",
"enabled": true,
"callback_token": "22b7893e7fa1c4c60847090f78fbf0ec",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"url": "http://company.aha.io/integrations/204584239",
"resource": "http://company.aha.io/api/v1/integrations/204584239",
"owner": {
"type": "Project",
"id": "131414752",
"url": "http://company.aha.io/projects/PRJ1",
"resource": "http://company.aha.io/projects/PRJ1"
}
}
}