Configuring notifications

Specify a sender name and email address, and customize notifications based on templates.

About this task

The API Manager emails are sent automatically when certain system events occur. The email templates are organized by scope, as explained in Table 1.
Table 1. Notification scopes
Scope Events that trigger the notification
catalog Activities related to Catalogs; such as application life cycle events, invitations to catalogs, product approvals, and subscription approvals.
consumer Activities to consumer applications and subscription requests in the Developer Portal, invitations to Consumer organizations, and password reset requests for Developer Portal accounts.
provider Invitations.
space Invitations.

One of the following roles is required to configure email notifications:

  • Administrator
  • Owner
  • A custom role with the Settings:Manage permission

Procedure

  1. In API Manager, click Settings Settings.
  2. In the Settings navigation list, click Notifications, then click Edit.
  3. Specify a sender by entering a Name and Email address, then click Save.
  4. Optional: Customize notification templates. Complete the following steps:
    1. Enable template customization by moving the Customize notification templates slider to the On position.
      Note: You can reload all the default notifications, as configured by a cloud administrator, by disabling and re-enabling template customization. However, doing so will overwrite any customizations. For more information on customizing notifications as a cloud administrator, see Customizing email notification templates.
    2. To preview the text for a template, select Preview from the options menu Options menu icon alongside the template name.
    3. To edit the text for the template, either click the template name, or select Edit in the options menu alongside the template name.

      When a template is opened, an attempt is made to get the language from the browser setting, but if this isn't possible the template defaults to English.

      The text includes variables; for example, {{catalog}}. The notification text is based on Handlebars syntax. Most variables are enclosed in double curly braces {{ }}, but can be enclosed in triple curly braces {{{ }}} to disable HTML escaping, when the variable is a URL link for example. For more information on Handlebars, see https://handlebarsjs.com/.

      To obtain the complete list of variables that are available for a particular notification template, complete the following steps:
      1. Log in to the management server from the command line as a member of a provider organization; for details, see Logging in to a management server. You can use the same management server URL, user name, and password in the login command that you use to log in to the API Manager user interface.
      2. Enter the following command:
        apic notification-templates:get template_name --server mgmt_endpoint_url --scope org --org provider_organization --subcollection template_scope --fields variables --output -
        where:
        • template_name is the name of the required notification template, as displayed in the Template column in the user interface.
        • template_scope is the scope name displayed in the Scope column alongside that template.
        • provider_organization is the value of the name field for your provider organization.
        For example:
        apic notification-templates:get member-invitation --server https://myserver.com --scope org --org myorg --subcollection catalog --fields variables --output -
        The variables that are available for the template are displayed, for example:
        variables:
  - org
  - catalog
  - activationLink
  - expiresAt
  - originator
  - originatorFirstName
  - originatorLastName
  - originatorEmail
  - username
  - email
  - firstName
  - lastName

        The --output - parameter causes the command output to be written to the command line. You can specify --output filepath to have the output written to a .yaml file at the specified location, or omit it altogether to have a file written to the current folder.

    4. To view and edit the notification template in a different language, select one of the following supported languages from the View template in drop-down list:
      • Chinese (Simplified)
      • Chinese (Traditional)
      • Czech
      • Dutch
      • English (US English)
      • French
      • German
      • Italian
      • Japanese
      • Korean
      • Polish
      • Portuguese
      • Russian
      • Spanish
      • Turkish
    5. Click Save when done.
      Note: Edits made to a template are saved only for the specific language version that is edited.