Skip to content
Nappai Documentation

Jira Webhook

Jira Webhook is a starting component: it starts the flow when one of the events you choose happens in your Jira Cloud, for example an issue is created or changed, someone comments, or a sprint starts. NappAI registers the notification in your Jira with your credential, so you don’t have to set anything up inside Jira.

When to use it

  • Every new issue should send a message to the team’s channel.
  • When an issue changes status you want to notify the customer who reported it.
  • You want an AI agent to read every new comment and suggest a reply.
  • When a sprint starts or closes you want to generate a summary automatically.

Configuration

You need a Jira API credential with your Jira Cloud address, your Atlassian account email and an API token. See Credentials.

FieldWhat it does
Credential (required)Your Jira’s Jira API credential. It is used to register the notification in Jira.
EventsThe events that start the flow. You can choose several. If you choose none, or choose All Events (*), all of them count.
DataFor testing the component: paste a sample Jira notification here and run the flow to see the result.

The available events are:

  • Issues: Issue Created, Issue Updated, Issue Deleted.
  • Comments: Comment Created, Comment Updated, Comment Deleted.
  • Issue properties: Issue Property Set, Issue Property Deleted.
  • Sprints: Sprint Created, Sprint Updated, Sprint Started, Sprint Closed, Sprint Deleted.
  • Versions: Version Created, Version Updated, Version Released, Version Unreleased, Version Moved, Version Merged, Version Deleted.

Registering the notification in Jira

  1. Deploy a version of the flow. Registering needs a deployed version. See Versions and publishing.
  2. In the component, below its fields, click Consume. The API Access window opens on the Jira Webhook tab.
  3. Click Register Webhook. NappAI creates the notification in your Jira with the chosen events and replaces any earlier notification of this same flow.
  4. The tab compares the Flow Events with the Jira Events and shows Synced when they match. If you change the component’s events, it shows Out of sync and the list of events to add or remove: register the notification again.
  5. To stop receiving notifications, click Delete Webhook.

Output

The Data output returns the event, tidied up:

  • The event (webhook_event), its category (event_category, for example issue, comment or sprint) and what happened (operation, for example created).
  • The date (timestamp) and the person who triggered it (user).
  • If the event concerns an issue, its details in issue: key, title, description, status, priority, assignee, reporter, type, dates and project.
  • If something changed, the list of changes in changelog, with the field, the old value and the new one.
  • If the event concerns a comment, its details in comment: text, author and dates.

If an event arrives that is not among those chosen in Events, the flow stops at this component and does not continue.

Connect Data to an agent, a messaging component or Jira Issue Handler to reply on the issue itself.

Example

A product team wants to hear about every new issue in its chat.

  1. Add Jira Webhook with your Jira credential and choose Issue Created in Events.
  2. Connect Data to an agent that writes a short notice with the key, title and priority, and that agent to a messaging component.
  3. Deploy the flow, click Consume in the component and then Register Webhook.

Good practices

  • Choose only the events you will use. Issue Updated happens very often and would run the flow on every change.
  • If you change the events after registering the notification, register it again so Jira sends the new ones.