Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info

You can use this REST API to develop integrations between Company Calendar for Jira and other applications or systems. This page documents the available REST resources along with expected HTTP responses and sample requests.

To use REST API, an admin has to generate a token tied either to specific calendars or all calendars. It’s recommended to assign minimum calendars per token and to create "All Calendars" tokens only when it’s needed.

Tip

Introduced in the app version 8.1, users are able to create, edit and delete calendars and custom event sources via REST API. The editing and deletion of calendars and sources can be managed on the token level.

image-20241111-100931.pngImage Added
Info

Please note that it is important to use a token based on the “All” calendars options should you wish to add new calendars via REST API.

URL Structure

To use REST API, your application will make an HTTP request and parse the response.

...

Note

Important: It is necessary to provide the complete value JSON object when updating resources. If any properties are omitted in the update request, they will be overwritten or lost. To retain all existing properties, ensure that you include them in the request body during the update.

...

Note

Important: It is necessary to provide the complete value JSON object when updating resources. If any properties are omitted in the update request, they will be overwritten or lost. To retain all existing properties, ensure that you include them in the request body during the update.

...