Event Notifications CLI

ibmcloud event-notifications init

Set the instance that you'll we working on by using the following command:

ibmcloud event-notifications init [--instance-id INSTANCE-ID]

ibmcloud event-notifications environment variables set

• export IBMCLOUD_EN_ENDPOINT variable to set the Event Notifications region public endpoint.

  • Dallas: https://us-south.event-notifications.cloud.ibm.com/event-notifications
  • London: https://eu-gb.event-notifications.cloud.ibm.com/event-notifications
  • Sydney: https://au-syd.event-notifications.cloud.ibm.com/event-notifications
  • Frankfurt: https://eu-de.event-notifications.cloud.ibm.com/event-notifications
  • Madrid: https://eu-es.event-notifications.cloud.ibm.com/event-notifications

• export IBMCLOUD_EN_ENDPOINT variable to set the Event Notifications region private endpoint.

  • Dallas: https://private.us-south.event-notifications.cloud.ibm.com/event-notifications
  • London: https://private.eu-gb.event-notifications.cloud.ibm.com/event-notifications
  • Sydney: https://private.au-syd.event-notifications.cloud.ibm.com/event-notifications
  • Frankfurt: https://private.eu-de.event-notifications.cloud.ibm.com/event-notifications
  • Madrid: https://private.eu-es.event-notifications.cloud.ibm.com/event-notifications

• export EVENT_NOTIFICATIONS_API_KEY variable to set the Event Notifications instance apikey.

ibmcloud event-notifications show

Check your configuration.

ibmcloud event-notifications show

ibmcloud event-notifications source create

• Action: Create Source.

  [Supported till version 0.2.0]

  ibmcloud event-notifications source create --instance-id INSTANCE-ID --name NAME --description DESCRIPTION [--enabled ENABLED]
  

  [From version 1.0.0]

  ibmcloud event-notifications source-create --instance-id INSTANCE-ID --name NAME --description DESCRIPTION [--enabled ENABLED]
  

• Parameters to provide:

  [--instance-id INSTANCE-ID] (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  --name NAME (int64)

  The name to be provided for API source.

  The default value is . The maximum length is 255 characters. The minimum length is 1 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

  --description DESCRIPTION (string)

  The description for source.

  The default value is ``. The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

  --enabled ENABLED (Boolean)

  The Boolean flag to enable or disable the source.

  The value is set to true to enable the source and false to disable the source.

ibmcloud event-notifications source update

• Action: Update Source. [Supported till version 0.2.0]

  ibmcloud event-notifications source update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--enabled ENABLED]
  

  [From version 1.0.0]

  ibmcloud event-notifications source-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--enabled ENABLED]
  

• Parameters to provide:

  --instance-id (string)

  Unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  --name (int64)

  API Source name.

  The default value is ``. The maximum length is 255 characters. The minimum length is 1 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

  --description (int64)

  API Source Description

  The default value is ``. The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

  --enabled (Boolean)

  Search string for filtering results.

  The value is set to true to enable the source and false to disable the source.

  --id (string)

  Unique identifier for Source. Required.

  The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z0-9-:_]*/.

ibmcloud event-notifications source list

• Action: List all Source. [Supported till version 0.2.0]

  ibmcloud event-notifications source list [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--instance-id INSTANCE-ID]
  

  [From version 1.0.0]

  ibmcloud event-notifications sources [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--instance-id INSTANCE-ID]
  

• Parameters to provide:

  --limit LIMIT (int64)

  The page limit for paginated results.

  The maximum value is 100. The minimum value is 1.

  --offset OFFSET (int64)

  The offset for paginated results.

  The minimum value is 0.

  --search SEARCH (string)

  The search string for filtering results.

  The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.

  [--instance-id INSTANCE-ID] (string)

  The Unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  [--force]

  Activate to force resource deletion (to bypass the confirmation prompt).

ibmcloud event-notifications source get

• Action: Get specific Source. [Supported till version 0.2.0]

  ibmcloud event-notifications source get --id ID [--instance-id INSTANCE-ID]
  

  [From version 1.0.0]

  ibmcloud event-notifications source --id ID [--instance-id INSTANCE-ID]
  

• Parameters to provide:

  --id ID (string)

  Unique identifier for source. Required.

  The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z0-9-:_]*/.

  --offset OFFSET

  The offset for paginated results.

  --search SEARCH

  The search string for filtering results.

  [--instance-id INSTANCE-ID] (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  [--force]

  Activate to force resource deletion (to bypass the confirmation prompt).

ibmcloud event-notifications source delete

• Action: Delete specific Source.

  [Supported till version 0.2.0]

  ibmcloud event-notifications source delete --instance-id INSTANCE-ID --id ID
  

  [From version 1.0.0]

  ibmcloud event-notifications source-delete  --instance-id INSTANCE-ID --id ID
  

• Parameters to provide:

  --id ID (string)

  Unique identifier for source. Required.

  The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z0-9-:_]*/.

  [--instance-id INSTANCE-ID] (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  [--force]

  Activate to force resource deletion (to bypass the confirmation prompt).

ibmcloud event-notifications destination create

• Action: Create a destination. [Supported till version 0.2.0]

  ibmcloud event-notifications destination create --name NAME --type TYPE [--description DESCRIPTION] [--certificate CERTIFICATE] [--certificate-content-type CERTIFICATE-CONTENT-TYPE] [--config CONFIG] [--instance-id INSTANCE-ID]
  

  [From version 1.0.0]

  ibmcloud event-notifications destination-create --instance-id INSTANCE-ID --name NAME --type TYPE [--description DESCRIPTION] [--collect-failed-events COLLECT-FAILED-EVENTS] [--config CONFIG] [--certificate CERTIFICATE] [--certificate-content-type CERTIFICATE-CONTENT-TYPE] [--icon16x16 ICON16X16] [--icon16x16-content-type ICON16X16-CONTENT-TYPE] [--icon16x162x ICON16X162X] [--icon16x162x-content-type ICON16X162X-CONTENT-TYPE] [--icon32x32 ICON32X32] [--icon32x32-content-type ICON32X32-CONTENT-TYPE] [--icon32x322x ICON32X322X] [--icon32x322x-content-type ICON32X322X-CONTENT-TYPE] [--icon128x128 ICON128X128] [--icon128x128-content-type ICON128X128-CONTENT-TYPE] [--icon128x1282x ICON128X1282X] [--icon128x1282x-content-type ICON128X1282X-CONTENT-TYPE]
  

• Parameters to provide:

  --instance-id (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  --name NAME (string)

  The name of the destination. Required.

  The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

  --type TYPE (string)

  The type of the destination. The options available are webhook, push_android, push_ios. Required.

  Allowable values are: webhook. The minimum length is 1 character.

  --collect-failed-events (bool)

  Whether to collect the failed event in Cloud Object Storage bucket.

  The default value is false.

  --description DESCRIPTION (string)

  The description of the destination.

  The default value is . The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

  --certificate CERTIFICATE (string)

  The certificate file path to be provided. The allowed file type is p8 and p12 certificate. Provide file location to pass the certificate.

  --certificate-content-type CERTIFICATE-CONTENT-TYPE (string)

  The certificate content type to be set in the case of iOS destination. The default value is ``. The available options are: p8 or p12.

  --config CONFIG (DestinationConfig examples)

  The configuration needed to set the destination-specific parameters.

  --icon16x16 (io.ReadCloser)

  Safari icon 16x16.

  The maximum length is 5000 characters. The minimum length is 1 character.

  --icon16x16-content-type (string)

  The content type of Icon16x16.

  --icon16x162x (io.ReadCloser)

  Safari icon 16x16@2x.

  The maximum length is 5000 characters. The minimum length is 1 character.

  --icon16x162x-content-type (string)

  The content type of Icon16x162x.

  --icon32x32 (io.ReadCloser)

  Safari icon 32x32.

  The maximum length is 5000 characters. The minimum length is 1 character.

  --icon32x32-content-type (string)

  The content type of Icon32x32.

  --icon32x322x (io.ReadCloser)

  Safari icon 32x32@2x.

  The maximum length is 5000 characters. The minimum length is 1 character.

  --icon32x322x-content-type (string)

  The content type of Icon32x322x.

  --icon128x128 (io.ReadCloser)

  Safari icon 128x128.

  The maximum length is 5000 characters. The minimum length is 1 character.

  --icon128x128-content-type (string)

  The content type of Icon128x128.

  --icon128x1282x (io.ReadCloser)

  Safari icon 128x128@2x.

  The maximum length is 5000 characters. The minimum length is 1 character.

  --icon128x1282x-content-type (string)

  The content type of Icon128x1282x.

  {
     "params" : {
        "url" : "exampleString",
        "verb" : "get",
        "custom_headers" : { },
        "sensitive_headers" : [ "exampleString" ]
     }
  }
  

• Examples:

  • The following example shows format of the DestinationConfig object for iOS destination with P8 certificate. Set pre_prod Boolean parameter to true to configure destination as pre-production destination else set the value as false:

    {
       "params" : {
          "cert_type" : "p8",
          "is_sandbox" : true,
          "key_id": "production",
          "team_id": "1234",
          "bundle_id": "test1",
          "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    

  • The following example shows format of the DestinationConfig object for iOS destination with P12 certificate. Set pre_prod Boolean parameter to true to configure destination as pre-production destination else set the value as false.

    {
       "params" : {
          "cert_type" : "p12",
          "is_sandbox" : true,
          "password": "apnspasswordvalue",
          "pre_prod" : "true" true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    

  • The following example shows the format of the DestinationConfig object for Chrome destination. Set pre_prod Boolean parameter to true to configure destination as pre-production destination else set the value as false.

    {
       "params" : {
          "api_key": "chromeapikey",
          "website_url" : "https://testwebsite.com",
          "pre_prod" : "true" true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    

  • The following example shows format of the DestinationConfig object for Firefox destination. Set pre_prod Boolean parameter to true to configure destination as pre-production destination else set the value as false.

    {
       "params" : {
          "website_url" : "https://testwebsite.com",
          "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    

  • The following example shows format of the DestinationConfig object for Slack destination.

    {
       "params" : {
          "url" : "https://hooks.slack.com/services/G0gyhsush/TYodsjhs/GHTbfidsimkk"
       }
    }
    

  • The following example shows format of the DestinationConfig object for Safari destination. Set pre_prod Boolean parameter to true to configure destination as pre-production destination else set the value as false.

    {
       "params": {
          "cert_type":"p12",
          "certificate_name":"Users/Testuser/Documents/safari.p12",
          "password":"safarinew",
          "url_format_string":"https://test.com",
          "website_name":"testwebsite",
          "website_push_id":"test",
          "website_url":"https://test.com",
          "pre_prod" : "true" // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    

  • The following example shows format of the DestinationConfig object for MS Teams destination.

    {
       "params" : {
          "url" : "https://xyz.webhook.office.com"
       }
    }
    

  • The following example shows format of the DestinationConfig object for IBM Cloud® Functions destination.

    {
       "params" : {
          "url" : "https://www.ibmcfendpoint.com",
          "api_key" : "cffunctionnamespaceserviceidapikey"
       }
    }
    

  • The following example shows format of the DestinationConfig object for PagerDuty destination.

    {
       "params" : {
          "routing_key" : "routingkeytoconnecttoPD",
          "api_key" : "cffunctionnamespaceserviceidapikey"
       }
    }
    

  • The following example shows the format of the DestinationConfig object for webhook.

    {
       "params" : {
          "url" : "exampleString",
          "verb" : "get",
          "custom_headers" : { },
          "sensitive_headers" : [ "exampleString" ]
       }
    }
    

  • The following example shows the format of the DestinationConfig object for push_android destination.

    {
       "params" : {
          "project_id" : "6232305230320",
          "private_key" : "36e21epfweort823or8rt832pr8p2r832pr82pr382r8f",
          "client_email" : "testuser.123@gmail.com",
          "pre_prod" : true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    

  • The following example shows the format of the DestinationConfig object for ServiceNow destination.

    {
       "params" : {
          "client_id" : "359705ceddd100eyfewyyw1f0f9e1c96",
          "client_secret": "testsecrets",
          "username": "testuser",
          "password": "user_password",
          "instance_name": "testinstancenje"
       }
    }
    

  • The following example shows the format of the DestinationConfig object for Code Engine destination.

    {
       "params" : {
          "url" : "https://codeengine.test.com",
          "verb" : "get",
          "custom_headers" : { },
          "sensitive_headers" : [ "exampleString" ]
       }
    }
    

  • The following example shows the format of the DestinationConfig object for IBM Cloud Object Storage destination.

    {
       "params" : {
          "bucket_name" : "cos-destination-en-bucket",
          "instance_id" : "42e13636e-0548-41a0-a178-e95be28464773",
          "endpoint" : "https://s3.us-west.cloud-object-storage.appdomain.cloud"
       }
    }
    

  • The following example shows the format of the DestinationConfig object for Huawei destination.

    {
       "params" : {
          "client_id" : "359705ceddd100eyfew",
          "client_secret": "testsecrets",
          "pre_prod" : true // Set to true in case of configuring Destination as pre-prod Destination (pre_prod destination can only be configured for Standard plan)
       }
    }
    

  • The following example shows the format of the DestinationConfig object for Custom Email destination.

    Process To do the Custom Domain Configuration and Verification: https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-destinations-custom-email#en-destinations-custom-email-verify

    {
       "params" : {
          "domain": "mailx.com"
       }
    }
    

  Note: The Custom SMS Destination does not require any Destination Config To be set up.

ibmcloud event-notifications destination list

• Action: List all Destination.

  [Supported till version 0.2.0]

  ibmcloud event-notifications destination list [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--instance-id INSTANCE-ID]
  

  [From version 1.0.0]

  ibmcloud event-notifications destinations [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--instance-id INSTANCE-ID]
  

• Parameters to provide:

  --limit LIMIT (int64)

  The page limit for paginated results.

  The maximum value is 100. The minimum value is 1.

  --offset OFFSET (int64)

  The offset for paginated results.

  The minimum value is 0.

  --search SEARCH (string)

  The search string for filtering results.

  The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.

  --instance-id (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

ibmcloud event-notifications destination get

• Action: Get specific Destination.

  [Supported till version 0.2.0]

  ibmcloud event-notifications destination get --id ID [--instance-id INSTANCE-ID]
  

  [From version 1.0.0]

  ibmcloud event-notifications destination --id ID [--instance-id INSTANCE-ID]
  

• Parameters to provide:

  --id ID (string)

  The unique identifier for destination. Required.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  [--instance-id INSTANCE-ID] (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

ibmcloud event-notifications destination update

• Action: Update existing Destination.

  [Supported till version 0.2.0]

  ibmcloud event-notifications destination update --id ID [--name NAME] [--description DESCRIPTION] [--certificate CERTIFICATE] [--config CONFIG] [--instance-id INSTANCE-ID]
  

  [From version 1.0.0]

  ibmcloud event-notifications destination-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--collect-failed-events COLLECT-FAILED-EVENTS] [--config CONFIG] [--certificate CERTIFICATE] [--certificate-content-type CERTIFICATE-CONTENT-TYPE] [--icon16x16 ICON16X16] [--icon16x16-content-type ICON16X16-CONTENT-TYPE] [--icon16x162x ICON16X162X] [--icon16x162x-content-type ICON16X162X-CONTENT-TYPE] [--icon32x32 ICON32X32] [--icon32x32-content-type ICON32X32-CONTENT-TYPE] [--icon32x322x ICON32X322X] [--icon32x322x-content-type ICON32X322X-CONTENT-TYPE] [--icon128x128 ICON128X128] [--icon128x128-content-type ICON128X128-CONTENT-TYPE] [--icon128x1282x ICON128X1282X] [--icon128x1282x-content-type ICON128X1282X-CONTENT-TYPE]
  

• Parameters to provide:

  --instance-id (string) : Unique identifier for IBM Cloud Event Notifications instance. Required.

  The maximum length is 256 characters. The minimum length is 10 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--id (string)

Unique identifier for Destination. Required.

The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

--name (string)

Destination name.

The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--description (string)

Destination description.

The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

--collect-failed-events (bool)

Whether to collect the failed event in Cloud Object Storage bucket.

The default value is false.

--config (DestinationConfig)

Payload describing a destination configuration.

Provide a JSON string option or specify a JSON file to read from by providing a filepath option that begins with a @, e.g. --config=@path/to/file.json.

--certificate (io.ReadCloser)

Certificate for APNS.

The maximum length is 5000 characters. The minimum length is 1 character.

--certificate-content-type (string)

The content type of Certificate.

--icon16x16 (io.ReadCloser)

Safari icon 16x16.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon16x16-content-type (string)

The content type of Icon16x16.

--icon16x162x (io.ReadCloser)

Safari icon 16x16@2x.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon16x162x-content-type (string)

The content type of Icon16x162x.

--icon32x32 (io.ReadCloser)

Safari icon 32x32.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon32x32-content-type (string)

The content type of Icon32x32.

--icon32x322x (io.ReadCloser)

Safari icon 32x32@2x.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon32x322x-content-type (string)

The content type of Icon32x322x.

--icon128x128 (io.ReadCloser)

Safari icon 128x128.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon128x128-content-type (string)

The content type of Icon128x128.

--icon128x1282x (io.ReadCloser)

Safari icon 128x128@2x.

The maximum length is 5000 characters. The minimum length is 1 character.

--icon128x1282x-content-type (string)

The content type of Icon128x1282x.

ibmcloud event-notifications destination delete

• Action: Delete existing Destination.

  [Supported till version 0.2.0]

  ibmcloud event-notifications destination delete --id ID [--instance-id INSTANCE-ID] [--force]
  

  [From version 1.0.0]

  ibmcloud event-notifications destination-delete --id ID [--instance-id INSTANCE-ID] [--force]
  

• Parameters to provide:

  --id ID (string)

  The unique identifier for destination. Required.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  [--instance-id INSTANCE-ID] (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  [--force] (Boolean)

  Activate to force resource deletion (to bypass the confirmation prompt).

ibmcloud event-notifications enabled-countries

Get enabled country details of SMS destination.

ibmcloud event-notifications enabled-countries --instance-id INSTANCE-ID --id ID

ibmcloud event-notifications enabled-countries \
    --instance-id=exampleString \
    --id=exampleString

ibmcloud event-notifications test-destination

Test a Destination.

ibmcloud event-notifications test-destination --instance-id INSTANCE-ID --id ID

ibmcloud event-notifications test-destination \
    --instance-id=exampleString \
    --id=exampleString

ibmcloud event-notifications verify-destination-update

Verify SPF and DKIM records of custom domain.

ibmcloud event-notifications verify-destination-update --instance-id INSTANCE-ID --id ID --type TYPE

ibmcloud event-notifications verify-destination-update \
    --instance-id exampleString \
    --id exampleString \
    --type exampleString

ibmcloud event-notifications topic create

• Action: Create new Topic.

  [Supported till version 0.2.0]

  ibmcloud event-notifications topic create --name NAME [--description DESCRIPTION] [--sources SOURCES] [--instance-id INSTANCE-ID]
  

  [From version 1.0.0]

  ibmcloud event-notifications topic-create --name NAME [--description DESCRIPTION] [--sources SOURCES] [--instance-id INSTANCE-ID]
  

• Parameters to provide:

  --name NAME (string)

  Name of the topic. Required.

  The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

  --description DESCRIPTION (string)

  Description of the topic.

  The default value is ``. The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

  [--instance-id INSTANCE-ID] (string)

  Unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  [--sources SOURCES] (TopicCreateSourcesItem[])

  The list of sources.

• Example:

  • The following example shows the format of the TopicCreateSourcesItem[] object.

    [
       {
          "id" : "exampleString",
          "rules" : [
             {
                "enabled" : true,
                "event_type_filter" : "$.*",
                "notification_filter" : "exampleString"
             }
          ]
       }
    ]
    

  • The following example shows the format of the TopicUpdateSourcesItem[] object.

    [
       {
          "id" : "exampleString",
          "rules" : [
             {
                "enabled" : true,
                "event_type_filter" : "exampleString",
                "notification_filter" : "exampleString",
                "rule_id" : "exampleString"
             }
          ]
       }
    ]
    

ibmcloud event-notifications topic list

• Action: List all Topic.

  [Supported till version 0.2.0]

  ibmcloud event-notifications topic list [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--instance-id INSTANCE-ID]
  

  [From version 1.0.0]

  ibmcloud event-notifications topics [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--instance-id INSTANCE-ID]
  

• Parameters to provide:

  --limit LIMIT (int64)

  The page limit for paginated results.

  The maximum value is 100. The minimum value is 1.

  --offset OFFSET (int64)

  The offset for paginated results.

  The minimum value is 0.

  --search SEARCH (string)

  The search string for filtering results.

  The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.

  [--instance-id INSTANCE-ID] (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

ibmcloud event-notifications topic get

• Action: Get specific Topic.

  [Supported till version 0.2.0]

  ibmcloud event-notifications topic get --id ID [--include INCLUDE] [--instance-id INSTANCE-ID]
  

  [From version 1.0.0]

  ibmcloud event-notifications topic --id ID [--include INCLUDE] [--instance-id INSTANCE-ID]
  

• Parameters to provide:

  --id ID (string)

  Unique identifier for topic. Required.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

  --include INCLUDE (string)

  Include sub topics.

  The default value is ``. The maximum length is 20 characters. The minimum length is 0 characters. The value must match regular expression /[a-z]/.

  [--instance-id INSTANCE-ID] (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

ibmcloud event-notifications topic update

• Action: Update existing Topic.

  [Supported till version 0.2.0]

  ibmcloud event-notifications topic update --id ID [--name NAME] [--description DESCRIPTION] [--sources SOURCES] [--instance-id INSTANCE-ID]
  

  [From version 1.0.0]

  ibmcloud event-notifications topic-replace --id ID [--name NAME] [--description DESCRIPTION] [--sources SOURCES] [--instance-id INSTANCE-ID]
  

• Parameters to provide:

  --instance-id (string)

  Unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  --id (string)

  Unique identifier for topic. Required.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

  --name (string)

  Name of the topic.

  The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

  --description (string)

  Description of the topic.

  The default value is ``. The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*()]*/.

  --sources (TopicUpdateSourcesItem[])

  List of sources.

ibmcloud event-notifications topic delete

• Action: Delete existing Topic.

  [Supported till version 0.2.0]

  ibmcloud event-notifications topic delete --id ID [--instance-id INSTANCE-ID] [--force]
  

  [From version 1.0.0]

  ibmcloud event-notifications topic-delete --id ID [--instance-id INSTANCE-ID] [--force]
  

• Parameters to provide:

  --id ID (string)

  Unique identifier for topic. Required.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

  [--instance-id INSTANCE-ID] (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  [--force] (Boolean)

  Activate to force resource deletion (to bypass the confirmation prompt).

ibmcloud event-notifications subscription create

• Action: Create new Subscription.

  [Supported till version 0.2.0]

  ibmcloud event-notifications subscription create [--name NAME] [--description DESCRIPTION] [--destination-id DESTINATION-ID] [--topic-id TOPIC-ID] [--attributes ATTRIBUTES] [--instance-id INSTANCE-ID]
  

  [From version 1.0.0]

  ibmcloud event-notifications subscription-create --instance-id INSTANCE-ID --name NAME --destination-id DESTINATION-ID --topic-id TOPIC-ID [--description DESCRIPTION] [--attributes ATTRIBUTES] 
  

• Parameters to provide:

  --name NAME (string)

  The name to be set for subscription.

  The maximum length is 50 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

  --instance-id INSTANCE-ID (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  --description DESCRIPTION (string)

  The description to be set for subscription.

  The default value is ``. The maximum length is 255 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

  --destination-id DESTINATION-ID (string)

  The destination ID to be set for subscription.

  The maximum length is 150 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

  --topic-id TOPIC-ID (string)

  The topic ID to be set for subscription.

  The maximum length is 150 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

  --attributes ATTRIBUTES (SubscriptionCreateAttributes)

  The attributes to be set for subscription.

• Examples:

  • The following example shows the format of the SubscriptionCreateAttributes object for webhook.

    {
       "add_notification_payload" : true,
       "signing_enabled" : true
    }
    

  • The following example shows the format of the SubscriptionCreateAttributes object for SMS.

    {
       "invited" :["+1xxxxxxxxxx", "+1xxxxxxxxxx"]
    }
    

  • The following example shows the format of the SubscriptionCreateAttributes object for IBM Email.

    {
       "invited" :["entest@gmail.com"],
       "add_notification_payload": true,
       "reply_to_mail": "en@ibm.com",
       "reply_to_name": "EYS ORG",
       "from_name":"ABC ORG"
    }
    

  • The following example shows the format of the SubscriptionCreateAttributes object for slack.

    {
       "attachment_color" : "#FF0000"
    }
    

  • The following example shows the format of the SubscriptionCreateAttributes object for ServiceNow.

    {
       "assigned_to" : "serviceuser@gmail.com",
       "assignment_group" : "incidentgroup"
    }
    

  • The following example shows the format of the SubscriptionCreateAttributes object for Custom Email.

    {
       "invited" :["entest@gmail.com"],
       "add_notification_payload": true,
       "reply_to_mail": "en@ibm.com",
       "reply_to_name": "EYS ORG",
       "from_name":"ABC ORG",
       "from_email":"Testuser@mailx.com",
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
       "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa"
    }
    

ibmcloud event-notifications subscription list

• Action: List all Subscription.

  [Supported till version 0.2.0]

  ibmcloud event-notifications subscription list [--offset OFFSET] [--limit LIMIT] [--search SEARCH] [--instance-id INSTANCE-ID]
  

  [From version 1.0.0]

  ibmcloud event-notifications subscriptions [--offset OFFSET] [--limit LIMIT] [--search SEARCH] [--instance-id INSTANCE-ID]
  

• Parameters to provide:

  --limit LIMIT (int64)

  The page limit for paginated results.

  The maximum value is 100. The minimum value is 1.

  --offset OFFSET (int64)

  The offset for paginated results.

  The minimum value is 0.

  --search SEARCH (string)

  The search string for filtering results.

  The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.

  [--instance-id INSTANCE-ID] (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

ibmcloud event-notifications subscription get

• Action: Get specific Subscription.

  [Supported till version 0.2.0]

  ibmcloud event-notifications subscription get --id ID [--instance-id INSTANCE-ID]
  

  [From version 1.0.0]

  ibmcloud event-notifications subscription --id ID [--instance-id INSTANCE-ID]
  

• Parameters to provide:

  --id ID (string)

  Unique identifier for subscription. Required.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

  [--instance-id INSTANCE-ID] (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

ibmcloud event-notifications subscription delete

• Action: Delete existing Subscription.

  [Supported till version 0.2.0]

  ibmcloud event-notifications subscription delete --id ID [--instance-id INSTANCE-ID] [--force]
  

  [From version 1.0.0]

  ibmcloud event-notifications subscription-delete --id ID [--instance-id INSTANCE-ID] [--force]
  

• Parameters to provide:

  --id ID (string)

  Unique identifier for subscription. Required.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

  [--instance-id INSTANCE-ID] (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  [--force] (Boolean)

  Activate to force resource deletion (to bypass the confirmation prompt).

ibmcloud event-notifications subscription update

• Action: Update existing Subscription.

  [Supported till version 0.2.0]

  ibmcloud event-notifications subscription update --id ID [--name NAME] [--description DESCRIPTION] [--attributes ATTRIBUTES] [--instance-id INSTANCE-ID]
  

  [From version 1.0.0]

  ibmcloud event-notifications subscription-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--attributes ATTRIBUTES]
  

• Parameters to provide:

  --id ID (string)

  Unique identifier for subscription. Required.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

  [--name NAME] (string)

  The updated description to be set for subscription.

  The maximum length is 100 characters. The minimum length is 1 character. The value must match regular expression /[a-zA-Z0-9-:_]*/.

  [--instance-id INSTANCE-ID] (string)

  The Unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  [--description DESCRIPTION] (string)

  The updated description to be set for subscription.

  The default value is ``. The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9-:_]*/.

  [-attributes ATTRIBUTES] (SubscriptionUpdateAttributes)

  The attributes to be set for subscription

• Examples:

  • The following example shows the format of the SubscriptionUpdateAttributes object for Webhook.

    {
       "signing_enabled": true
    }
    

  • The following example shows the format of the SubscriptionUpdateAttributes object for IBM SMS.

    {
       "invited": {
          "add": ["+8xxxxxxxxxx"],
          "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"]
       },
       "subscribed": {
          "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"]
       },
       "unsubscribed": {
          "remove": ["+1xxxxxxxxxx", "+91xxxxxxxxxx"]
       }
    }
    

  • The following example shows the format of the SubscriptionUpdateAttributes object for IBM Email.

    {
       "invited": {
          "add": ["example1@gmail.com"],
          "remove": []
       },
       "subscribed": {
          "remove": ["example2@gmail.com"]
       },
       "unsubscribed": {
          "remove": ["example3@gmail.com"]
       },
       "reply_to_mail": "example@ibm.com",
       "reply_to_name": "USA news",
       "from_name": "IBM",
       "add_notification_payload": true
    }
    

  • The following example shows the format of the SubscriptionUpdateAttributes object for Custom Email.

    {
       "invited": {
          "add": ["example1@gmail.com"],
          "remove": []
       },
       "subscribed": {
          "remove": ["example2@gmail.com"]
       },
       "unsubscribed": {
          "remove": ["example3@gmail.com"]
       },
       "reply_to_mail": "example@ibm.com",
       "reply_to_name": "USA news",
       "from_name": "IBM",
       "from_email": "test@email.com",
       "add_notification_payload": true,
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
       "template_id_invitation": "f1ef32fb-b7dd-4405-xxxx-7b6719cee8aa"
    }
    

  • The following example shows the format of the SubscriptionUpdateAttributes object for Slack.

    {
       "attachment_color" : "#FF0000"
    }
    

  • The following example shows the format of the SubscriptionUpdateAttributes object for Service Now.

    {
       "assigned_to" : "serviceuser@gmail.com",
       "assignment_group" : "incidentgroup"
    }
    

ibmcloud event-notifications tag subscription create

• Action: Create Tag-Subscription.

  [From version 1.0.0]

  ibmcloud event-notifications tags-subscription-create --instance-id INSTANCE-ID --id ID --device-id DEVICE-ID --tag-name TAG-NAME
  

• Parameters to provide:

  --id ID (string)

  Unique identifier for Destination. Required.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

  --tag-name TAG-NAME (string)

  The offset for paginated results.

  The default value is . The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

  ----device-id DEVICE-ID (string)

  Unique identifier of the device.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

  [--instance-id INSTANCE-ID] (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

ibmcloud event-notifications tag subscription delete

• Action: Delete Tag-Subscription.

  [From version 1.0.0]

  ibmcloud event-notifications tags-subscription-delete --instance-id INSTANCE-ID --id ID --device-id DEVICE-ID --tag-name TAG-NAME
  

• Parameters to provide:

  --id ID (string)

  Unique identifier for Destination. Required.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

  --tag-name TAG-NAME (string)

  The offset for paginated results.

  The default value is . The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

  ----device-id DEVICE-ID (string)

  Unique identifier of the device.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

  [--instance-id INSTANCE-ID] (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

ibmcloud event-notifications tag subscription list

• Action: list Tag-Subscriptions.

  [From version 1.0.0]

  ibmcloud event-notifications tags-subscription --instance-id INSTANCE-ID --id ID [--device-id DEVICE-ID] [--user-id USER-ID] [--tag-name TAG-NAME] [--limit LIMIT] [--offset OFFSET] [--search SEARCH]
  

• Parameters to provide:

  --id ID (string)

  Subscription Tag ID. Required.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

  --tag-name TAG-NAME (string)

  The offset for paginated results.

  The default value is . The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

  ----device-id DEVICE-ID (string)

  Unique identifier of the device.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}/.

  ----user-id USER-ID (string)

  The user identifier for the device registration.

  The default value is . The maximum length is 255 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z 0-9-_\/.?:'";,+=!#@$%^&*() ]*/.

  --limit LIMIT (int64)

  The page limit for paginated results.

  The maximum value is 100. The minimum value is 1.

  --offset OFFSET (int64)

  The offset for paginated results.

  The minimum value is 0.

  --search SEARCH (string)

  The search string for filtering results.

  The maximum length is 100 characters. The minimum length is 0 characters. The value must match regular expression /[a-zA-Z0-9]/.

  [--instance-id INSTANCE-ID] (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

ibmcloud event-notifications integration Create

ibmcloud event-notifications integration-create --instance-id INSTANCE-ID --type TYPE --metadata METADATA

ibmcloud event-notifications integration replace

Replace Integration.

[Supported till version 0.2.0]

ibmcloud event-notifications Integration replace --instance-id INSTANCE-ID --id ID --type Type --metadata METADATA

[From version 1.0.0]

ibmcloud event-notifications integration-replace --instance-id INSTANCE-ID --id ID --type Type --metadata METADATA

• Examples:

  • The following example shows the format of the IntegrationCreateAttributes object.

    {
       "endpoint": "https://s3.us-west.cloud-object-storage.appdomain.cloud",
       "crn": "crn:v1:bluemix:public:cloud-object-storage:global:xxxxxxx6db359a81a1dde8f44bxxxxxx:xxxxxxxx-1d48-xxxx-xxxx-xxxxxxxxxxxx::",
       "bucket_name": "cloud-object-storage"
    }
    

ibmcloud event-notifications integration list

List all Integrations.

[Supported till version 0.2.0]

ibmcloud event-notifications Integration list [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--instance-id INSTANCE-ID]

[From version 1.0.0]

ibmcloud event-notifications integrations [--limit LIMIT] [--offset OFFSET] [--search SEARCH] [--instance-id INSTANCE-ID]

ibmcloud event-notifications Integration get

Get specific Integration.

[Supported till version 0.2.0]

ibmcloud event-notifications Integration get --id ID [--instance-id INSTANCE-ID]

[From version 1.0.0]

ibmcloud event-notifications integration --id ID [--instance-id INSTANCE-ID]

ibmcloud event-notifications template-create

Create a new Template.

ibmcloud event-notifications template-create --instance-id INSTANCE-ID --name NAME --type TYPE [--params PARAMS] [--description DESCRIPTION]

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type exampleString \
    --params '{"body": "exampleString", "subject": "exampleString"}' \
    --description exampleString

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type exampleString \
    --description exampleString \
    --params-body exampleString \
    --params-subject exampleString

ibmcloud event-notifications templates

List all Templates. Note: If the --all-pages option is not set, the command will only retrieve a single page of the collection.

ibmcloud event-notifications templates --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH]

ibmcloud event-notifications templates \
    --instance-id exampleString \
    --limit 10 \
    --offset 0 \
    --search exampleString

ibmcloud event-notifications template

Get details of a Template.

ibmcloud event-notifications template --instance-id INSTANCE-ID --id ID

ibmcloud event-notifications template \
    --instance-id exampleString \
    --id exampleString

ibmcloud event-notifications template-update

Update details of a Template.

ibmcloud event-notifications template-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--type TYPE] [--params PARAMS]

ibmcloud event-notifications template-update \
    --instance-id exampleString \
    --id exampleString \
    --name exampleString \
    --description exampleString \
    --type exampleString \
    --params '{"body": "exampleString", "subject": "exampleString"}'

ibmcloud event-notifications template-update \
    --instance-id exampleString \
    --id exampleString \
    --name exampleString \
    --description exampleString \
    --type exampleString \
    --params-body exampleString \
    --params-subject exampleString

ibmcloud event-notifications template-delete

Delete a Template.

ibmcloud event-notifications template-delete --instance-id INSTANCE-ID --id ID

ibmcloud event-notifications template-delete \
    --instance-id exampleString \
    --id exampleString

ibmcloud event-notifications Send notifications

• Action: Use below command to send notifications in cli version 0.0.7.

  ibmcloud event-notifications send-notifications --instance-id INSTANCE-ID --subject SUBJECT --severity SEVERITY --id ID --source SOURCE --en-source-id EN-SOURCE-ID --type TYPE --time TIME [--data DATA] [--push-to PUSH-TO] [--message-fcm-body MESSAGE-FCM-BODY] [--message-apns-headers MESSAGE-APNS-HEADERS] [--message-apns-body MESSAGE-APNS-BODY] [--datacontenttype DATACONTENTTYPE] [--specversion SPECVERSION]
  

• Action: Use below command to send notifications in cli version 0.0.8 and higher.

  ibmcloud event-notifications send-notifications --instance-id INSTANCE-ID [--body BODY] [--ce-ibmenseverity CE-IBMENSEVERITY] [--ce-ibmendefaultshort CE-IBMENDEFAULTSHORT] [--ce-ibmendefaultlong CE-IBMENDEFAULTLONG] [--ce-ibmenfcmbody CE-IBMENFCMBODY] [--ce-ibmenapnsbody CE-IBMENAPNSBODY] [--ce-ibmenpushto CE-IBMENPUSHTO] [--ce-ibmenapnsheaders CE-IBMENAPNSHEADERS] [--ce-ibmenchromebody CE-IBMENCHROMEBODY] [--ce-ibmensafaribody CE-IBMENSAFARIBODY] [--ce-ibmenfirefoxbody CE-IBMENFIREFOXBODY] [--ce-ibmenchromeheaders CE-IBMENCHROMEHEADERS] [--ce-ibmenfirefoxheaders CE-IBMENFIREFOXHEADERS] [--ce-ibmensourceid CE-IBMENSOURCEID] [--ce-id CE-ID] [--ce-source CE-SOURCE] [--ce-type CE-TYPE] [--ce-specversion CE-SPECVERSION] [--ce-time CE-TIME]
  

• Action: Use below command to send notifications in cli version 0.1.1 and higher.

   ibmcloud event-notifications send-notifications --instance-id INSTANCE-ID [--body BODY]
  

• Parameters to provide:

  [--instance-id INSTANCE-ID] (string)

  The unique identifier for IBM Cloud Event Notifications instance.

  The maximum length is 36 characters. The minimum length is 36 characters. The value must match regular expression /[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]/.

  --subject SUBJECT (string)

  The subject for notification.

  The minimum length is 1 character.

  [--severity SEVERITY] or --ce-ibmenseverity CE-IBMENSEVERITY (string)

  The level of severity for notification. Required.

  The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.

  --id or --ce-id (string)

  The Notification ID. Required

  The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.

  [--source SOURCE] or -ce-source CE-SOURCE (string)

  The source description. Required

  The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.

  [--en-source-id] or --ce-ibmensourceid CE-IBMENSOURCEID (string)

  The source ID to be set for Notification source. Required.

  The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.

  [--type TYPE] or [--ce-type CE-TYPE] (string)

  The type of notification. Required.

  The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.

  [--time TIME] or [--time TIME] (string)

  The Timestamp to be set for notification. Required.

  The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/.

  [--datacontenttype DATACONTENTTYPE] (string)

  The data content type for notification. Required.

  The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_\/. Default value is application/json.

  [--specversion SPECVERSION] or [--ce-specversion CE-SPECVERSION] (string)

  The spec version value. Default value to be used is 1.0.

  The minimum length is 1 character. The value must match regular expression /[0-9]. Default value is 1.0.

  [--push-to PUSH-TO] or [--ce-ibmenpushto CE-IBMENPUSHTO] DeviceDataConfiguration

  The Device data information to send data in case of Registered Devices / Users IDs / Platforms. For broadcast, choose {}.

  [--message-fcm-body MESSAGE-FCM-BODY] or [--ce-ibmenfcmbody CE-IBMENFCMBODY] FCMMessageBodyDataPayload

  FCM message body to send notification to FCM devices.

  [--message-apns-headers MESSAGE-APNS-HEADERS] or [--ce-ibmenapnsheaders CE-IBMENAPNSHEADERS] [APNSHeaders#en-cli-send-notification-example-schema)

  The Custom APNS headers information can be set by using this option.

  [--message-apns-body MESSAGE-APNS-BODY] or [--ce-ibmenapnsbody CE-IBMENAPNSBODY] APNSMessageBody

  The apns message body can be set by using this option.

  [--body BODY] DataPayload)

  The body payload to be provided for notification.

  [--ce-ibmendefaultshort] (string)

  The short text for notification to send.

  The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*/.

  [--ce-ibmendefaultlong CE-IBMENDEFAULTLONG] (string)

  The long text for notification top sends.

  The minimum length is 1 character. The value must match regular expression /[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*/.

  [--ce-ibmenchromebody CE-IBMENCHROMEBODY] ChromeMessageBody

  Chrome message body to send notification to FCM devices.

  [--ce-ibmensafaribody CE-IBMENSAFARIBODY]

  Safari message body to send notification to Safari devices.

  [--ce-ibmenfirefoxbody CE-IBMENFIREFOXBODY] FirefoxMessageBody

  Firefox message body to send notification to FCM devices.

  [--ce-ibmenchromeheaders CE-IBMENCHROMEHEADERS] ChromeHeaders

  The Custom Chrome headers information can be set by using this option.

  [--ce-ibmenfirefoxheaders CE-IBMENFIREFOXHEADERS] FirefoxHeaders

  The Custom Firefox information can be set by using this option.

• Examples:

  • The following example shows the format of data payload for sending notifications.

    {
       "data": {
          "createTimestamp": 1557282940339,
          "severity": "LOW",
          "shortDescription": "examplestring"
       }
    }
    

  • The following example shows the format of FCM message body to send notification to FCM devices.

    {"message":{
       "data":{
            "alert": "examlestring", "delay_while_idle":true,"time_to_live":2,"collapse_key":"testCollapseKey","notification":{"title":"Match update","body":"Arsenal goal in added time, score is now 3-0"},"data":{"alert":"Notification alert message","url":"https","payload":{"mydevicearra":["cc75e4a6-edd8-3bec-a7c3-dfca6572a03b"]}}
            }
       }
    }
    

  • The following example shows the format of Chrome message body to send notification to FCM devices.

    {"title":"Hello Chrome", "en_data":{"alert":"Hello Chrome Notification","title":"Chrome New Title","iconUrl":"https://","timeToLive":100,"payload":{"key":"value"}}}
    

  • The following example shows the format of Firefox message body to send notification to FCM devices.

    '{"title":"Hello Firefox", "en_data":{"alert":"Hello firefox Notification","title":"firefox New Title","iconUrl":"https://","timeToLive":100,"payload":{"key":"value"}}}'
    

  • The following example shows the format of apns/chrome/fireox custom headers.

    {
        "test": "test header",
        "new": "newmessage"
    }
    

  • The following example shows the format of APNS message body to send notification to FCM devices.

    {"data":{"alert":"alert","url":"https","badge":9,"sound":"bingbong.aiff","payload":"{\\\"fcm_devices\\\": [\\\"cc75e4a6-edd8-3bec-a7c3-dfca6572a03b\\\"]}","type":"DEFAULT","subtitle":"dummy","title":"dummy1","body":"body","ios_action_key":"key","interactive_category":"interactiveCategory","title_loc_key":"titleLocKey","loc_key":"GAME_PLAY_REQUEST_FORMAT","launch_image":"image.png","title_loc_args":["Shelly","Rick"],"loc_args":["Shelly","Rick"],"attachment_url":"some url","apns_collapse_id":"12","apns_thread_id":"1","apns_group_summary_arg":"apnsGroupSummaryArg","apns_group_summary_arg_count":1}}
    

  • The following example shows the format of body to send notification to slack destination.

    {"specversion" : "1.0","source": "github.io/pr","ibmensourceid": "4e22c0fe-5db3-49ce-9b86-47d3fd57f7a8:api","id":"1234-1234-sdfs-234", "time" : "2018-04-05T17:31:00Z","type":"com.ibm.cloud.compliance.certificate_manager:certificate_expired", "subject":"12345678",  "ibmenseverity":"HIGH","ibmensmstext":"Test message for EN - 5syat56","ibmensubject":"Findings on IBM Cloud Security Advisor's","ibmenhtmlbody":" \"Hi  ,<br/>Certificate expiring in 90 days.<br/><br/>Please login to <a href=\"https: //cloud.ibm.com/security-compliance/dashboard\">Security and Complaince dashboard</a> to find more information<br/>\" ","ibmendefaultshort":"Security findings in your IBM Cloud Account","ibmendefaultlong":"Certificate expiring in 90 days. Please login to cloud console to find more information","ibmenfcmbody": "{\"notification\":{\"title\":\"Hello, Tag!\",\"time_to_live\":100}}",
    "ibmenapnsbody": "{\"en_data\":{\"alert\":\"alert\"},\"aps\":{\"alert\":{\"loc-args\":[\"Shelly\",\"Rick\"],\"action-loc-key\":\"key\",\"launch-image\":\"image.png\",\"loc-key\":\"GAME_PLAY_REQUEST_FORMAT\",\"subtitle\":\"Tes Sub apns 9\",\"summary-arg\":\"apnsGroupSummaryArg\",\"body\":\"Pradeep Notification 10\",\"title-loc-key\":\"titleLocKey\",\"title\":\"Test apns 9\",\"summary-arg-count\":1,\"title-loc-args\":null},\"badge\":9,\"sound\":\"bingbong.aiff\",\"category\":\"interactiveCategory\",\"thread-id\":\"12\",\"mutable-content\":1},\"url\":\"https\",\"apns-collapse-id\":\"10\",\"attachment-url\":\"some url\"}",
    "message_apns_headers": "{\"apns-collapse-id\": \"13\"}", "ibmenapnsheaders": "{\"apns-collapse-id\": \"13\"}","ibmenchromebody": "{\"title\":\"Hello Chrome\", \"en_data\":{\"alert\":\"Hello Chrome Notification\",\"title\":\"Chrome New Title\",\"iconUrl\":\"https://\",\"timeToLive\":100,\"payload\":{\"key\":\"value\"}}}","ibmenfirefoxbody": "{\"title\":\"Hello Firefox\", \"en_data\":{\"alert\":\"Hello Firefox Notification\",\"title\":\"Firefox New Title\",\"iconUrl\":\"https://\",\"timeToLive\":100,\"payload\":{\"key\":\"value\"}}}","ibmenfirefoxheaders": "{\"TTL\":100}","ibmenchromeheaders":"{\"TTL\":100}" ,"ibmenpushto": "{\"platforms\":[\"push_ios\"]}","datacontenttype" : "application/json", "data": {"author": {"account_id": "dgduyeiueiinchdidkuedfrr","email": "testuser@gmail.com","id": "IBMid-76893","kind": "user" },"create_time": "2022-02-28T13:28:14.043755123Z","create_timestamp": 1646054894,"issuer": "IBM Cloud Security and Compliance Center","issuer_url": "https://cloud.ibm.com/security-compliance","long_description": "Success! Your Event Notifications instance is configured with IBM Cloud Security and Compliance Center.","payload_type": "test","reported_by": {"id": "compliance","title": "IBM Cloud Security and Compliance Center", "url": "https://cloud.ibm.com/security-compliance"},"severity": "LOW","short_description": "Success! Your Event Notifications instance is configured with IBM Cloud Security and Compliance Center.","transaction_id":"6a25fd3d-8530-43b9-96a5-ede2a7712bc9"}
    

  • The following example shows the target device configuration example.

    {"fcm_devices": ["deviceidstring"],"user_ids": ["useridstring"], "platforms": ["G"]}
    

  • The following example shows the send notification general payload for cli version above 0.1.1

    ibmcloud en send-notifications --instance-id <instance-id> --body '{"id": "b2198eb8-04b1-48ec-a78c-ee87694dd845", "time": "2018-04-05T17:31:00Z","type": "*","subject": "This is a simple monitoring test alert!!","message_text": "Hi, Welcome from the IBM Cloud - Event Notifications service!", "message_subject": "This is a simple monitoring test alert!!","source": "apisource/git", "specversion": "1.0","ibmensourceid": "e9785d21-4780-467a-8836-c530f5v6738:api","data": {"alert": "En Proactive monitoring","message": "Hi, Welcome from the IBM Cloud - Event Notifications service"},"ibmenfcmbody": "{\"notification\": {\"title\": \"En Proactive monitoring test alert!\"}}","ibmenpushto": "{\"platforms\": [\"push_chrome\", \"push_firefox\", \"push_android\"]}","ibmenapnsbody": "{\"aps\": {\"alert\": \"En Proactive monitoring test alert!\"}}","ibmenchromebody": "{\"title\": \"En Proactive monitoring test alert!\"}","ibmenchromeheaders": "{\"TTL\": 3600}","ibmenfirefoxbody": "{\"title\": \"En Proactive monitoring test alert!\"}","ibmenfirefoxheaders": "{\"TTL\": 3600}","datacontenttype": "application/json","ibmendefaultlong": "Hi, we are making sure from our side that the service is available for consumption. If you are receiving this event, it means we doing fine. Thank you.","ibmendefaultshort": "This is a proactive monitoring test alert from IBM Cloud Event Notifications service."}'