Allow external notifications through API

This section describes how to configure external notifications through API.
This setting is necessary to process notifications through API sent from systems other than Garoon.
Received notifications are displayed in "Notifications" portlet and "Notifications" screen.
Notifications are not displayed if settings for external notifications through API and values of notification data sent from API do not match.

Image of notifications portlet

Adding External Notifications through API

You can add external notifications through API.

Steps:

  1. Click the administration menu icon (gear icon) in the header.

  2. Click Garoon System Administration.

  3. Select "Application settings" tab.

  4. Click Notifications.

  5. Click "External notifications".

  6. In "External notifications" screen, click "New".

    Image of the Add External Notifications link which is surrounded by the red rectangle box

  7. Select "API" checkbox for "External notifications to allow" field in "Add external notification" screen.

    Image of an API surrounded by a red rectangle box

  8. Enter an item in "External notification Code" field.

    This external notification code is mandatory. This is a unique code for identifying external notifications.
    You can configure any value to the external notification code. However, there is a limitation on the maximum number of characters to be used.
    For details, refer to the "Adding external notifications" section under the list of the allowed number of input characters.

    The external notification code configured for API requests and for Garoon must be the same.
    If you have configured the external notification code using a plug-in, make sure you enter the same value.
    For details on API requests, refer to the topic on registering notification in cybozu developer network.
    Image of External notification code input field

  9. Input a display name of external notification in "Display name" field.

    The name is mandatory.
    Image of input field of Display name
    This display name is used as an application name displayed in "Notifications" portlet and "Notifications" screen.
    Screenshot: Displayed as an application name on the "Notifications" screen

  10. In "Permitted URLs" field, input link URLs for notifications.

    You must input all URLs which you want to permit.
    Enter each URL on a separate line. You can use a wildcard character "*".
    You can also specify URLs for notification icons. If omitted, the build-in bell icon for external notifications through API is configured as a notification icon.

    If you have configured the URL such as "URL included in a notification" and "notification icon" in the API request, make sure you enter them in the "Permitted URLs" field in Garoon.
    For details on API requests, refer to the topic on registering notification in cybozu developer network.
    Image of the input field for URLs to be Permitted

  11. Select "Enabled" for "Status" field.

    Image of the Enabled radio button which is surrounded by the red rectangle box

  12. Confirm your settings and click Add.

Changing External Notifications through API

You can edit settings of external notifications through API.

Steps:

  1. Click the administration menu icon (gear icon) in the header.

  2. Click Garoon System Administration.

  3. Select "Application settings" tab.

  4. Click Notifications.

  5. Click "External notifications".

  6. In "External notifications" screen, click the external notification (through API) code which you want to edit.

  7. In "External notification details" screen, click Edit.

    Image of an edit action link

  8. In "Edit external notification" screen, configure necessary items.

  9. Confirm your settings and click Save.

Deleting External Notifications through API

You can delete external notifications through API.
Even if you delete the configuration of external notifications through API, notifications which you have already received are not deleted. However, once you deleted, you cannot filter notifications in "Notifications" portlet and "Notifications" screen.

Deleting External Notifications through API One by One

You can delete external notifications through API one by one.

Steps:

  1. Click the administration menu icon (gear icon) in the header.

  2. Click Garoon System Administration.

  3. Select "Application settings" tab.

  4. Click Notifications.

  5. Click "External notifications".

  6. In "External notifications" screen, click the external notification (through API) code which you want to delete.

  7. In "External notification details" screen, click Delete.

    Image of a delete action link

  8. Click Yes in the "Delete external notification" screen.

Deleting Multiple External Notifications through API in Bulk

You can select multiple external notifications through API and delete them in bulk.

Steps:

  1. Click the administration menu icon (gear icon) in the header.

  2. Click Garoon System Administration.

  3. Select "Application settings" tab.

  4. Click Notifications.

  5. Click "External notifications".

  6. In "External notifications" screen, select checkboxes of external notifications through API which you want to delete and click Delete.

    Image of the Delete button which is surrounded by the red rectangle box

  7. Click Yes in the "Bulk deletion of external notifications" screen.