Notifications

Channel: JIRA

JIRA Notifications

JIRA integration allows Vaktum to automatically create and update issues in your JIRA instance based on API test results and other events.

Setting Up JIRA Notifications

  1. Navigate to Workspace SettingsNotifications
  2. Click "Add Notification Channel"
  3. Select "JIRA" as the channel type
  4. Configure the following settings:
    • Base URL: The base URL of your JIRA instance (e.g., https://your-company.atlassian.net).
    • Project Key: The key of the JIRA project where issues should be created (e.g., PROJ).
    • Issue Type ID: The ID of the JIRA issue type to be used (e.g., 10001 for Task, 10004 for Bug). You can find this ID in your JIRA settings or by inspecting API responses.
    • Username: Your JIRA username (often an email address).
    • Personal Access Token (PAT): Your JIRA Personal Access Token. This is treated like a password and will be masked.
    • Event Types: Select which events should trigger JIRA issue creation/updates.

Connecting to JIRA & Obtaining a Personal Access Token (PAT)

To obtain a JIRA Personal Access Token:

  1. Log in to your JIRA account.
  2. Click on your profile picture in the bottom left (or top right, depending on your JIRA version).
  3. Go to Profile settings.
  4. Under Security, find Personal Access Tokens (the exact menu name might vary slightly).
  5. Click "Create token".
  6. Give your token a descriptive name (e.g., "Vaktum Integration").
  7. Set appropriate permissions/scopes if required by your JIRA version. Ensure it has permissions to create and update issues in the target project.
  8. Copy the generated token. Store it securely, as JIRA will not show it to you again.
  9. Paste the token into Vaktum's JIRA notification settings in the "Personal Access Token (PAT)" field.

Troubleshooting JIRA Integration

If JIRA issues aren't being created or updated as expected:

  1. Verify PAT: Ensure your Personal Access Token is valid, not expired, and has the necessary permissions in JIRA to create/update issues in the specified project and issue type.
  2. Check Base URL: Confirm the Base URL is correct and accessible from where Vaktum is running.
  3. Validate Project Key and Issue Type ID: Double-check that the Project Key and Issue Type ID are accurate for your JIRA setup.
  4. Review Event Configuration: Ensure that events are occurring within Vaktum that match your notification criteria for the JIRA channel.
  5. Inspect JIRA Permissions: Make sure the user associated with the PAT has create/edit permissions in the target JIRA project.
  6. Check Vaktum Logs: Examine Vaktum's notification logs for any specific error messages related to the JIRA channel.