Webhooks API
Webhooks allow Aha! to receive real-time updates from integrated development tools and services. When configured properly, external systems can send webhook notifications to Aha! whenever relevant events occur (like issue updates, code commits, or task status changes).
Authentication: Webhooks use callback tokens instead of standard API authentication. Each integration has a unique callback token that must be included in webhook requests.
Supported Integrations: Aha! supports webhooks from many popular development tools including:
- Jira - Issue and project updates
- GitHub - Issue, pull request, and commit events
- Rally - Work item and project updates
- Asana - Task and project notifications
- Salesforce - Opportunity and case updates
- Smartsheet - Sheet and row changes
- Trello - Card and board updates
Setup Requirements:
- Integration must be properly configured and enabled
- Callback token must be valid and active
- Account must be in good standing (not disabled/suspended)
- Webhook payload must match the expected format for the integration type
Error Handling: Webhook endpoints return appropriate HTTP status codes:
200 OK
- Webhook processed successfully410 Gone
- Invalid token or disabled account500 Error
- Processing error (automatically retried by most systems)
Handle webhook processing errors gracefully
POST /api/v1/webhooks/:token
When webhook processing encounters errors (like validation failures or integration issues), the endpoint still returns 200 OK to prevent external systems from repeatedly retrying. Errors are logged internally for debugging and monitoring.
Examples of error scenarios that are handled gracefully:
- Invalid or missing field values
- Circular template dependencies
- Integration configuration issues
- Network or service connectivity problems
Name | Description |
---|---|
token * | Callback token for the integration |
Example request
POST /api/v1/webhooks/22b7893e7fa1c4c60847090f78fbf0ec
Example CURL command
curl "https://company.aha.io/api/v1/webhooks/22b7893e7fa1c4c60847090f78fbf0ec" -d '' -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "X-Hook-Secret: confirmation-secret-123" \
-H "Smartsheet-Hook-Challenge: smartsheet-challenge-456"
Request
contentType: application/json
accept: application/json
Response
Status: 200 OK
contentType: application/json