Jira Integration
Connect ProductBridge with Atlassian Jira to sync documentation tasks, link pages to issues, and streamline your project management workflow.
curl -X POST https://api.productbridge.com/integrations/jira/webhook \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"event": "issue.linked",
"issue_key": "DOC-142",
"doc_id": "doc_456",
"timestamp": "2025-03-10T14:00:00Z"
}'
{
"status": "ok",
"message": "Webhook received",
"linked": true
}
{
"error": "Invalid issue key",
"code": "JIRA_ISSUE_NOT_FOUND"
}
Overview
The Jira integration lets you connect ProductBridge to your Atlassian Jira instance so you can link documentation pages to Jira issues, track doc tasks alongside development work, and receive updates when linked issues change status.
You need a Jira Cloud or Jira Data Center instance with admin permissions to set up this integration.
Setup
Connect your Jira account
Navigate to Settings > Integrations > Jira in your ProductBridge dashboard.
Click Connect Jira and authorize ProductBridge to access your Jira instance.
Use a service account rather than a personal account so the connection persists if team members leave.
Select your Jira project
Choose the Jira project you want to link with ProductBridge.
You can connect multiple projects and map each to a specific documentation section.
{
"jira_project": "DOC",
"doc_section": "getting-started",
"sync_enabled": true
}
Configure sync settings
Choose which events trigger syncs between ProductBridge and Jira.
| Event | Direction | Description |
|---|---|---|
| Issue created | Jira → ProductBridge | Creates a linked doc task |
| Doc published | ProductBridge → Jira | Updates the linked issue status |
| Comment added | Bidirectional | Syncs comments between platforms |
Linking docs to Jira issues
You can link any documentation page to one or more Jira issues. Linked issues appear in the page sidebar and update automatically.
Open a documentation page and click Link Issue in the sidebar.
Search for the Jira issue by key (e.g., DOC-142) or summary text.
Linked: DOC-142 — Update API authentication guide
Status: In Progress
Assignee: jane@example.com
In any Jira issue, use the ProductBridge panel to link an existing doc page or create a new one.
The linked page URL appears in the issue details automatically.
Webhook events
ProductBridge sends webhook payloads for Jira-related events.
Last updated today
Built with Documentation.AI