Chatpane user guide
Chatpane sends Jira updates to Google Chat in two ways:
- Space notifications: each connection links one Google Chat space to the Jira spaces, events and filters it should hear about. You can have as many connections as you like.
- Personal messages: each person can get updates about their own work (assignments, mentions, work they reported or watch) as direct messages from the Chatpane app in Google Chat. See Personal messages.
Before you start
- You need Google Workspace (a business or education account). Personal Gmail accounts can't add webhooks to Chat spaces.
- You need to be a Jira admin, or a Jira space admin if your Jira admin allows space-level connections.
- If your organization's Google Workspace admin has turned off incoming webhooks, ask them to allow them (Google Admin console → Apps → Google Workspace → Google Chat).
Connect a Google Chat space
1. Get the webhook URL from Google Chat
- Open the Chat space that should receive Jira updates.
- Click the space name at the top, then Apps & integrations.
- Under Webhooks, click Add webhooks. Name it Jira (this is the name people see on each message) and click Save.
- Copy the webhook URL. Treat it like a password: anyone with it can post in the space.
2. Add the connection in Jira
- Go to Jira settings → Apps → Chatpane. Jira space admins: open your space, then Space settings → Apps → Chatpane.
- Click Add connection.
- Give it a name, for example the Chat space's name.
- Paste the Google Chat webhook URL.
- Choose what to send (see below), then click Save and send a test message.
A "Chatpane is connected" message appears in the Chat space within a few seconds. The webhook URL is stored securely and never shown again.
Choose what to send
| Setting | What it does |
|---|---|
| Jira spaces | Which Jira spaces this Chat space hears about. Leave empty for all. (Hidden on the space settings page, where it's always that space.) |
| Send a message when | Work item created, status changed, assignee changed, comment added, priority changed, work item resolved |
| Only when moved to | For status changes: only send when a work item moves to one of these statuses, such as Done or In Review. Leave empty for every status change |
| Work types | Only these work types, such as Bug. Leave empty for all |
| JQL filter | Only work items that match, such as priority in (High, Highest) or labels = customer. Checked when you save |
| Message style | Card, with the fields you pick and an Open in Jira button, or One compact line |
| Fields on the card | Status, assignee, priority, reporter, due date, labels |
| Include comment text | Switch off if comments shouldn't leave Jira; the message then just says someone commented |
| Keep each work item in its own thread | All updates about a work item go into one Chat thread. Switch off to post every update at the top level |
Editing a connection doesn't send another test message. Use Test if you want one.
Manage connections
The connections list shows each connection's Jira spaces, events, status and last message.
- Test sends a test message.
- Pause stops sending until you click Resume. Updates made while paused aren't sent later.
- Log shows the last 100 messages, with their result and how long delivery took.
- Delete removes the connection and forgets its webhook. Messages already in Google Chat stay there.
Broken connections. If a webhook is deleted from the Chat space, or Google refuses it, Chatpane marks the connection Broken, stops sending to it, and explains why at the top of the page. To fix it, add a new webhook in Google Chat, then Edit the connection, paste the new URL and click Save.
Jira space admins
Jira admins decide whether Jira space admins can connect their own spaces, with the checkbox at the bottom of Jira settings → Apps → Chatpane. It's on by default. Space admins only see the connections created from their space's settings. Jira admins see every connection.
Personal messages
Personal messages come from the Chatpane app in Google Chat, one-to-one with each person. They're off until a Jira admin turns them on.
Turn them on (Jira admin)
- Make sure the Chatpane app is allowed in your Google Workspace. Your Google Workspace admin can install it for everyone from the Google Workspace Marketplace, or allow people to add it themselves.
- In Jira settings → Apps → Chatpane, tick Let people get personal Google Chat messages about their own work. It saves straight away.
Connect your Google Chat (everyone)
- In Jira, open Settings (the gear icon, top right) → General settings, then Chatpane in the sidebar.
- In Google Chat, open Chatpane under Apps. If it isn't there, click New chat, type Chatpane and start a chat with it.
- On the Jira page, click Get my code, and send the code to Chatpane in Google Chat, like
link CP-AB12CD. Codes work for 10 minutes. - Chatpane replies "Connected to … on your-site.atlassian.net". Click Refresh on the Jira page.
Choose what you get
On the same Jira page, tick what should send you a message, then click Save:
| Setting | What it does |
|---|---|
| Work is assigned to me | Someone else assigns a work item to you, or creates one already assigned to you |
| Someone mentions me | Someone @mentions you in a work item or a comment |
| Work I reported changes | Status, assignee or priority changes, comments and resolutions on work items you reported |
| Work I watch changes | The same changes on work items you watch |
| Include comment text | Show the comment in the message. Switch off to only say someone commented |
| Pause all personal messages | Stop everything until you untick it |
You never get messages about your own changes, or about work items you can't open in Jira. Each message ends with why you got it, for example "You're the assignee". If one change matches several reasons, you get one message.
Test or disconnect
- Send a test message checks that messages reach you.
- Disconnect stops personal messages and forgets your Google Chat account. You can also type
unlinkto Chatpane in Google Chat, or remove the Chatpane app. - Type
helpto Chatpane for its commands.
Troubleshooting
- Nothing arrives: open Log for the connection. If the update isn't there, check the connection's filters: the Jira space, events, "Only when moved to", work types and JQL all have to match.
- "Google rejected the message": the log shows Google's reason. Send it to us and we'll help.
- Messages arrive a few seconds apart during busy moments: Google Chat accepts one message per second per space, so Chatpane queues bursts and sends them in order.
- Your Chatpane page says personal messages are off: ask a Jira admin to turn them on (see above).
- "That code isn't valid or has expired": codes work for 10 minutes, once. Click Get a new code and send that.
- Can't find Chatpane in Google Chat: your Google Workspace admin needs to allow or install the Chatpane app.
- Personal messages stopped: if you removed Chatpane in Google Chat, or your admin blocked it, the Jira page says so. Add Chatpane again in Google Chat, then connect again.
Privacy
Chatpane sends only what each connection is set up to send, and only to its Google Chat space, and personal messages only to the person who connected, about work items they can open. See the privacy policy.
Support
Email support@brainstaticthreads.com. We reply within 2 business days.
Google Chat and Google Workspace are trademarks of Google LLC. Chatpane isn't made or endorsed by Google.