Trigger Promptless from Jira Automation
Overview
Section titled “Overview”Use a Jira Automation flow when the Jira triggers don’t fit your workflow. A flow can start Promptless on a more specific condition. For example, it can run when a ticket is assigned to a specific teammate, or when every ticket in a release is marked done. Jira Automation’s own triggers, conditions, and actions decide when the flow runs.
The flow sends a web request with the ticket to the Promptless API trigger. Promptless works from the ticket and opens a documentation suggestion.
Before you start
Section titled “Before you start”You need:
- Permission to manage automation in the Jira space, or Jira admin access.
- Atlassian connected to Promptless. If it isn’t connected yet, connect it first.
- A Promptless API key for the flow. An organization admin creates one in Settings > API Access. See Create an API key.
Connect Atlassian
Section titled “Connect Atlassian”Skip this section if Atlassian is already connected on the Integrations page.
One Atlassian Cloud connection covers Jira, Confluence, or both. You need an admin role in your Promptless organization to connect it. Promptless reads Jira and Confluence with the permissions of the Atlassian account that approves the connection. If you attach an Atlassian service account, Promptless uses it for Jira instead. To connect a dedicated Atlassian account, log in to Atlassian as that account first.
-
On the Promptless Integrations page, select Connect Atlassian.
-
Select Jira, Confluence, or both, and select Continue to Atlassian. Promptless requests only the permissions for the products you select.
-
If Atlassian shows its login screen, log in with the account you want Promptless to use.
-
On the OAuth consent screen, review the permissions Promptless requests. For what each scope is for, see Permissions required.
-
Select Accept. If the consent screen shows no Accept option, your Atlassian account might not have the required permissions. Ask your Jira administrator to connect, or invite them to Promptless.
-
On the Promptless Integrations page, confirm the connection on the Atlassian card.
To manage Promptless’s access later, open Atlassian and go to your avatar > Account settings > Connected apps.
Choose an identity for Promptless in Jira
Section titled “Choose an identity for Promptless in Jira”Promptless reads, comments on, and creates Jira tickets as one of two accounts:
- With an Atlassian service account attached, Promptless uses the service account.
- Without a service account, Promptless reads Jira as the user who connected Atlassian, and its comments and tickets appear under that person’s name. Promptless comments or creates tickets only when your Knowledge Base or the request explicitly permits it. Without that permission, Promptless still does the documentation work and skips the Jira write. See Which account Promptless uses in Jira.
To assign tickets to Promptless itself, attach a service account as well.
Build the flow
Section titled “Build the flow”This example flow starts Promptless when a ticket in the space is assigned to a docs owner.
-
In Jira, open the space’s Space settings > Automation.
-
Select Create flow > Create from scratch.
-
Add the Work item assigned trigger.
-
In the trigger’s panel, select Add condition, then add a User condition.
-
In the condition, set User to Assignee, Check to perform to is, and Criteria to the docs owner.
-
Add a Send web request action. Set Web request URL to
https://api.gopromptless.ai/v1/triggersand HTTP method to POST. -
Set Web request body to Custom data, and enter the request body from Request body.
-
Under Headers (optional), add the key
Authorizationwith the valueBearer sk-pl-your-api-key, and select Hidden. -
Select Save and enable.
Request body
Section titled “Request body”The request body takes two fields:
instructionsis required and tells Promptless what to do. Name the ticket, and add any standing guidance for this flow, such as which docs to update.contextis optional. It appears with the request in trigger history on the Triggers page.
Jira smart values, such as {{issue.key}}, fill in details from the ticket that started the flow:
{ "instructions": "Update the documentation for Jira ticket {{issue.key}}. Comment on the ticket with a link to the docs PR.", "context": { "jira_issue": "{{issue.key}}", "jira_url": "{{issue.url}}" }}Confirm it works
Section titled “Confirm it works”To test the action before you save, expand Validate your web request configuration, enter a ticket key, and select Validate. Validating sends a real request, so Promptless starts a session for that ticket.
A request that starts a session returns 202 Accepted:
{ "trigger_event_id": "550e8400-e29b-41d4-a716-446655440000", "deduplicated": false}The request then appears on the Promptless Triggers page with its instructions and context. For any other status, open the flow’s Audit log and see Error responses.
See also
Section titled “See also”- API triggers, for the request format, error responses, and task status
- Jira triggers, to start Promptless from a label, mention, assignment, or configured Jira trigger
- Atlassian integration, for OAuth scopes and the service account