Important Update Effective February 1, 2024!
Due to recent changes in Jira and Confluence, we've made the tough decision to discontinue the OpenID Connect (OIDC)/OAuth app and no longer provide new versions for the newest Jira/Confluence releases as of January 31, 2024.
This is due to some necessary components no longer shipping with Jira/Confluence, which would require some extensive rewrites of the OIDC App.
API & Connectivity
Can the API be used to retrieve historical Out of Office data for reporting purposes?
No, the API only sends data in real time.
Feature request: For advanced options for reporting on historical data, please raise a ticket with our support team here, describing your use case.
What functionalities are covered by the Rest API for the Out of Office Assistant?
The API allows reading, creating, updating, and deleting Out of Office rules.
Further reading: Out of Office Assistant Rest API documentation
Can Rest API calls be used to set Out of Office statuses directly?
Yes, the API can create complete Out of Office rules, changing the status to “unavailable” as per the set dates.
Further reading: Out of Office Assistant Rest API documentation
Can the API be used to sync Out of Office statuses with external HR systems?
Yes, syncing Out of Office statuses with external HR systems is a primary use case supported by the API.
Further reading: Out of Office Assistant Rest API documentation
Is there an endpoint to batch update Out of Office statuses for multiple users through the API?
Yes, the “Post” Method allows creation of multiple Out of Office rules in one call for multiple users simultaneously.
Further reading: Out of Office Assistant Rest API documentation
What data is available through the API for reporting on Out of Office usage?
The API provides real-time data but does not offer information on additional Out of Office events like message postings or issue reassignments.
Feature request: If you’d like to add this information, please raise a ticket with our support team here.
Are there any pre-existing API connectors or templates for popular integration platforms like Zapier or IFTTT?
Yes, an Out of Office connector in Zapier supports creating Out of Office rules from external calendars or HR tools.
Further Reading: Integration with Zapier
Are there examples of custom integrations built with the Out of Office Assistant API?
Yes, custom integrations include the app for Slack and the integration with Tempo.
Further reading:
Can the API be used to set up complex Out of Office rules that utilize advanced JQL queries?
Yes, advanced JQL queries can be used in setting up Out of Office rules.
Further reading: Out of Office Assistant Rest API documentation
How can an administrator revoke an Out of Office API token if a user leaves the organization?
Out of Office access tokens can be revoked by admins from the REST API Permissions section in the User Administration page.
Further reading: Admin Walkthrough
Can the API be utilized to create a dashboard displaying Out of Office statuses?
Yes, Out of Office statuses can be sent via API to BI tools like Power BI or Tableau for dashboard creation.
Further reading: Out of Office Assistant Rest API documentation, Using JQL for Out of Office Status & Reporting on Issues Reassigned by Out of Office.
Do API calls to Out of Office Assistant count towards any JIRA quotas or limitations?
No, they do not.
Are there limitations on the fields that can be updated using Out of Office API PUT requests?
Yes, there are specific fields that can be updated: startDate, endDate, project, jqlSearchTerm, coverers, approverCoverers, approverField, message, shareWithCustomer, paused, and oooMentions.
Further reading: Out of Office Assistant Rest API documentation