Skip to content

Commit 9215291

Browse files
jmartin82claude
andcommitted
docs: document Jira connectors feature in README
Add Connectors section to Features, Admin Panel, and API Documentation. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent ffacbbf commit 9215291

1 file changed

Lines changed: 31 additions & 0 deletions

File tree

README.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -41,9 +41,15 @@ OpsLedger provides a single source of truth for all changes made to your infrast
4141
- **Key Rotation** - Easily rotate and revoke API keys
4242
- **Usage Tracking** - Monitor when keys were last used
4343

44+
### Connectors
45+
- **Jira Integration** - Connect OpsLedger to Jira via webhook. Incoming Jira issue events are automatically converted into change log entries using a configurable type mapping and environment label prefix
46+
- **Webhook Security** - Each connector is issued a unique secret; all incoming webhook payloads are verified with HMAC-SHA256 before processing
47+
- **Connector Management** - Admins can create, enable/disable, edit, and delete connectors from the dedicated Connectors page (`/connectors`)
48+
4449
### Admin Panel
4550
- User management (create, edit, delete users)
4651
- API key lifecycle management
52+
- Connector management (Jira webhooks)
4753
- Audit log for security tracking
4854

4955
### Real-time Updates
@@ -198,6 +204,31 @@ Returns `409 Conflict` if the change is already executed.
198204
| POST | `/api/admin/api-keys/:id/revoke` | Revoke an API key |
199205
| POST | `/api/admin/api-keys/:id/rotate` | Rotate an API key |
200206

207+
### Connectors API (admin only)
208+
209+
| Method | Endpoint | Description |
210+
|--------|----------|-------------|
211+
| GET | `/api/admin/connectors` | List all connectors |
212+
| POST | `/api/admin/connectors` | Create a new Jira connector |
213+
| PUT | `/api/admin/connectors/:id` | Update a connector |
214+
| DELETE | `/api/admin/connectors/:id` | Delete a connector |
215+
| POST | `/api/connectors/:id/webhook` | Jira webhook receiver (no auth — HMAC-verified) |
216+
217+
**Creating a Jira connector:**
218+
```json
219+
POST /api/admin/connectors
220+
{
221+
"name": "My Jira",
222+
"jira_url": "https://myorg.atlassian.net",
223+
"api_token": "your_jira_api_token",
224+
"mapping": {
225+
"type_map": { "Change": "configuration", "Deployment": "deployment", "Infrastructure": "infrastructure" },
226+
"environment_label_prefix": "env:"
227+
}
228+
}
229+
```
230+
The response includes the `secret` to use as the HMAC key when configuring the Jira webhook. Point your Jira automation webhook at `POST /api/connectors/:id/webhook`.
231+
201232
### Authentication
202233

203234
The API supports two authentication methods:

0 commit comments

Comments
 (0)