Clearly AIDocs

Jira

Connect Clearly AI to Jira.

Connect Jira so Clearly AI can read issue data and attachments, create or update Jira issues, add comments, and receive Jira events for Workflows.

Clearly AI acts as the Jira user whose credentials you configure. For example, if the API token belongs to alex@example.com, comments created by Clearly AI appear as Alex.

Jira comment authored by the credential owner

Prerequisites

  • A Clearly AI account with access to Integrations.
  • A Jira Cloud site, such as https://mycompany.atlassian.net.
  • Permission to create a Jira API token.
  • A Jira account with access to the projects and issues Clearly AI should use.

For shared or production use, ask your IT team to create a dedicated Jira service account, such as Clearly AI bot, and generate the API token from that account. This keeps Clearly AI activity separate from individual employee accounts.

Make the Jira account email visible

Jira webhook handling requires the email address for the credential owner to be visible. In Atlassian account settings, open Profile and visibility and set the account email visibility to Anyone.

Atlassian profile visibility settings

Create the Jira API token

  1. Open Atlassian account security.
  2. Under API tokens, click Create and manage API tokens.
  3. Create an API token with the scopes below.
  4. Set an expiry that matches your security policy. Atlassian tokens can expire no later than one year after creation.
  5. Copy the token. You will paste it into Clearly AI in the next step.

Use these scopes:

ScopePurpose
read:meIdentify the authenticated user
read:accountRead account details
read:jira-workRead issues, boards, and sprints
read:jira-userRead Jira user profiles
read:field:jiraRead custom and system fields
read:issue-details:jiraRead issue details
read:jql:jiraExecute JQL searches
read:attachment:jiraRead issue attachments
read:issue-type:jiraRead issue types
read:project:jiraRead project metadata
read:user:jiraRead user information
write:issue:jiraCreate and update issues
write:comment:jiraAdd and edit comments
write:attachment:jiraUpload attachments
write:jira-workUpdate issues, boards, and sprints

Jira API token scope selection

Jira API token created

Connect Jira in Clearly AI

  1. In Clearly AI, open Integrations and select Jira.
  2. In Base URL, enter your Jira site URL, such as https://mycompany.atlassian.net.
  3. In User Email, enter the email address for the Jira account that owns the API token.
  4. In Personal Key, paste the API token.
  5. Save the configuration.

Clearly AI Jira integration configuration

After saving, the Jira card may show an orange status indicator until the connection is tested.

Jira integration requires connection validation

Click Test. A successful test confirms Clearly AI can authenticate with Jira. If the test fails, the result should identify missing scopes, invalid credentials, or access problems.

Jira integration test result

Configure Jira webhooks for Workflows

Configure a webhook if you want Jira events, such as issue updates or label changes, to trigger Clearly AI Workflows.

Generate the Clearly AI webhook secret

  1. In the Clearly AI Jira integration settings, expand the Webhook section.
  2. Click Generate secret.
  3. Copy the generated secret and store it temporarily.
  4. Click Save.

Jira webhook configuration section

After saving, Clearly AI shows the Webhook URL. Copy it. You will use both the webhook URL and secret in Jira automation.

Jira webhook URL and secret

Create a Jira automation rule

In Jira, open Project settings > Automation > Create rule > Create from scratch.

Use Jira Automation, not Jira Webhooks. The example below sends an event to Clearly AI when selected labels are added or changed.

  1. Add a trigger:
    • Select Field value changed.
    • Set the field to Labels.
    • Set the change type to Any changes to the field value.
  2. Add a condition:
    • Select Work item fields condition.
    • Set the field to Labels.
    • Set the condition to contains any of.
    • Choose the label values that should trigger Clearly AI, such as clearly-needs-review.
  3. Add an action:
    • Select Send web request.
    • Set Web Request URL to the Clearly AI Webhook URL.
    • Set HTTP Method to POST.
    • Set Web Request Body to Issue Data (Automation format).
    • Add the headers below.
    • Enable Check to allow other rule actions to trigger this rule if another automation may add the trigger label.
HeaderValue
X-Clearly-Webhook-SecretThe Webhook Secret from Clearly AI
X-Clearly-UserThe Clearly AI user email to use when Jira cannot resolve a valid user from the event

Jira automation web request configuration

Validate the webhook

Return to the Jira integration in Clearly AI and use Validate your request configuration. A correct setup returns 200 OK. After validation succeeds, Jira events that match your automation rule can trigger Clearly AI Workflows.

Clearly AI webhook validation result

FAQs