Use the Backlog connector to manage projects, tasks, and software development workflows.
Integrating your application with Backlog lets you use these operations in an automation. It exposes 20 actions, listed below. Add the connector from the Connections area, authenticate, then select its operations in the automation builder. Capabilities: actions.
Authentication
Before you begin, make sure you have the following information:
Connection Name: Choose a meaningful name for your connection. This name helps you identify the connection within your application or integration settings.
Authentication Type: The authentication method for this connector is defined in the connection setup. Select the connector in the Connections area to see the fields it requires.
Authentication & setup
Backlog provides two authentication methods: API keys and OAuth 2.0.
API Key Authentication
Getting Your API Key:
Log into Backlog
Generate an API key (available in your account settings)
Include the key in API requests
Using the API Key: Append your API key to requests using the apiKey parameter in the URL:
https://xx.backlog.com/api/v2/users/myself?apiKey=YOUR_API_KEY
Note: Replace xx with your Backlog space identifier.
OAuth 2.0 Authentication
Backlog uses the Authorization Code Grant flow defined in RFC 6749.
Step 1: Register Your Application Register your application in the Backlog Developer Site to obtain:
client_id
client_secret
Step 2: Get Authorization Code Direct users to authorize your application
Step 3: Exchange for Access Token Use the authorization code to get an access token
Step 4: Make API Requests Include the token in the Authorization header:
Authorization: Bearer YOUR_ACCESS_TOKEN
Example Request:
GET /api/v2/space HTTP/1.1 Host: example.backlog.com Authorization: Bearer YOUR_ACCESS_TOKEN
Actions
Action Name | Description |
|---|---|
Add Category | Adds category to a project in Backlog |
Add project administrator | Adds a project administrator in Backlog |
Add user to project | Adds a user to a project in Backlog |
Add Version | Adds version to a project in Backlog |
Create issue | Creates a new issue in a project in Backlog |
Create project | Creates a new project in Backlog |
Delete a user from a project | Removes a user from project members in Backlog |
Delete Category | Deletes category of a project in Backlog |
Delete issue | Deletes an issue in a project in Backlog |
Delete project | Deletes a project in backlog |
Delete project administrator | Removes project administrator role from a user in Backlog |
Delete Version | Deletes version of a project in Backlog |
Get issue | Gets issue from a project in backlog |
Get project | Gets a project from Backlog |
List project users | Lists project users in Backlog |
List projects | Lists projects in Backlog |
Update Category | Updates category of a project in Backlog |
Update issue | Updates an issue in a project in Backlog |
Update project | Updates a project in Backlog |
Update Version | Updates version of a project in Backlog |
About the API
Backlog provides comprehensive project management APIs supporting:
Projects: Project creation and management
Issues: Issue tracking and lifecycle management
Users: User and team management
Milestones: Release and milestone planning
Versions: Version management
Comments: Issue comments and discussions
Custom Fields: Custom metadata for issues
Webhooks: Event notifications
Attachments: File and document management
Space: Workspace and organization settings