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

Sets the region that you'll be working on. The default endpoint region is Dallas. For other regions, change the endpoint by using the export command to set the variable, for example, use the following command for Sydney: export IBMCLOUD_EN_ENDPOINT=https://au-syd.event-notifications.cloud.ibm.com/event-notifications

• 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.

The command shows the initialized Event Notifications instance GUID.

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 sources-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" ]
     }
  }
  

  Note: The Event Notifications Destination Cloud Functions has been deprecated and no longer supported in category of destinations.

• 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 with type as incoming_webhook.

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

    • The following example shows format of the DestinationConfig object for Slack destination with type as direct_message.

    {
       "params" : {
          "type" : "direct_message",
          "token" : "vhdwvecwefwefewivcweivcwiwiciwcvwicwec"
       }
    }
    

  • 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 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.

    code engine destination type: application

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

    code engine destination type: job

    {
       "params" : {
          "type" : "job",
          "job_name" : "custom-job",
          "project_crn" : "crn:v1:bluemix:public:codeengine:us-south:a/e7e5820aeccb40efb78fd69a7858ef23:xxxxxxxxxxxxxx::"
          
       }
    }
    

  • 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.

    {
       "signing_enabled" : true,
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13"
    }
    

  • 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 Destination type as incoming_webhook.

    {
       "attachment_color" : "#FF0000",
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
    }
    

  • The following example shows the format of the SubscriptionCreateAttributes object for Slack Destination type as direct_message.

  {
     "channels" : [{ "id": "GHIUIFJHGGH"},{"id": "TSFDIDFOFNF"}],
     "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
  }
  

  • 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 for type as incoming_webhook.

    {
       "attachment_color" : "#FF0000",
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
    
    }
    

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

    {
       "channels": [{"id": "D01CFDTYBH", "operation": "add"}, {"id": "D01GHUTYBH", "operation": "remove"}],
       "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13",
    }
    

  • 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 \
    --params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
    --description exampleString

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type exampleString \
    --params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
    --description 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-replace

Update details of a Template.

ibmcloud event-notifications template-replace --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 smtp-configuration-create

Create a new SMTP Configuration.

ibmcloud event-notifications smtp-configuration-create --instance-id INSTANCE-ID --name NAME --domain DOMAIN [--description DESCRIPTION]

ibmcloud event-notifications smtp-configuration-create \
    --instance-id=exampleString \
    --name=exampleString \
    --domain=exampleString \
    --description=exampleString

ibmcloud event-notifications smtp-configurations

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

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

ibmcloud event-notifications smtp-configurations \
    --instance-id=exampleString \
    --limit=10 \
    --offset=0 \
    --search=exampleString

ibmcloud event-notifications smtp-user-create

Create a new SMTP User.

ibmcloud event-notifications smtp-user-create --instance-id INSTANCE-ID --id ID [--description DESCRIPTION]

ibmcloud event-notifications smtp-user-create \
    --instance-id=exampleString \
    --id=exampleString \
    --description=exampleString

ibmcloud event-notifications smtp-users

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

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

ibmcloud event-notifications smtp-users \
    --instance-id=exampleString \
    --id=exampleString \
    --limit=10 \
    --offset=0 \
    --search=exampleString

ibmcloud event-notifications smtp-configuration

Get details of a SMTP Configuration.

ibmcloud event-notifications smtp-configuration --instance-id INSTANCE-ID --id ID

ibmcloud event-notifications smtp-configuration \
    --instance-id=exampleString \
    --id=exampleString

ibmcloud event-notifications smtp-configuration-update

Update details of SMTP.

ibmcloud event-notifications smtp-configuration-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION]

ibmcloud event-notifications smtp-configuration-update \
    --instance-id=exampleString \
    --id=exampleString \
    --name=exampleString \
    --description=exampleString

ibmcloud event-notifications smtp-configuration-delete

Delete a SMTP Configuration.

ibmcloud event-notifications smtp-configuration-delete --instance-id INSTANCE-ID --id ID

ibmcloud event-notifications smtp-configuration-delete \
    --instance-id=exampleString \
    --id=exampleString

ibmcloud event-notifications smtp-user

Get details of a SMTP User.

ibmcloud event-notifications smtp-user --instance-id INSTANCE-ID --id ID --user-id USER-ID

ibmcloud event-notifications smtp-user \
    --instance-id=exampleString \
    --id=exampleString \
    --user-id=exampleString

ibmcloud event-notifications smtp-user-update

Update details of SMTP User.

ibmcloud event-notifications smtp-user-update --instance-id INSTANCE-ID --id ID --user-id USER-ID [--description DESCRIPTION]

ibmcloud event-notifications smtp-user-update \
    --instance-id=exampleString \
    --id=exampleString \
    --user-id=exampleString \
    --description=exampleString

ibmcloud event-notifications smtp-user-delete

Delete a SMTP user.

ibmcloud event-notifications smtp-user-delete --instance-id INSTANCE-ID --id ID --user-id USER-ID

ibmcloud event-notifications smtp-user-delete \
    --instance-id=exampleString \
    --id=exampleString \
    --user-id=exampleString

ibmcloud event-notifications smtp-allowed-ips

Get details of a SMTP allowed IPs.

ibmcloud event-notifications smtp-allowed-ips --instance-id INSTANCE-ID --id ID

ibmcloud event-notifications smtp-allowed-ips \
    --instance-id=exampleString \
    --id=exampleString

ibmcloud event-notifications smtp-allowed-ips-update

Note: The support for legacy allowlisting has been deprecated. The support has been enabled via Context-based-restrictions. For detailed information, please refer here: https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-smtp-configurations#en-smtp-configurations-cbr

ibmcloud event-notifications verify-smtp-update

Verify SPF and DKIM records of SMTP.

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

ibmcloud event-notifications verify-smtp-update \
    --instance-id=exampleString \
    --id=exampleString \
    --type=exampleString

ibmcloud event-notifications metrics

Get metrics.

ibmcloud event-notifications metrics --instance-id INSTANCE-ID --destination-type DESTINATION-TYPE --gte GTE --lte LTE [--id ID] [--email-to EMAIL-TO] [--notification-id NOTIFICATION-ID] [--subject SUBJECT]

ibmcloud event-notifications metrics \
    --instance-id=exampleString \
    --destination-type=smtp_custom \
    --gte=exampleString \
    --lte=exampleString \
    --id=exampleString \
    --email-to=exampleString \
    --notification-id=exampleString \
    --subject=exampleString

ibmcloud event-notifications send-notifications

Send Notifications body from the instance. For more information about Event Notifications payload, see here.

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

NotificationCreate

The following example shows the format of the NotificationCreate object.

{
  "specversion" : "1.0",
  "time" : "2019-01-01T12:00:00.000Z",
  "id" : "exampleString",
  "source" : "exampleString",
  "type" : "exampleString",
  "ibmenseverity" : "exampleString",
  "ibmensourceid" : "exampleString",
  "ibmendefaultshort" : "exampleString",
  "ibmendefaultlong" : "exampleString",
  "ibmensubject" : "exampleString",
  "ibmentemplates" : "[\"886f8f4c-8605-47hb-85a1-8682b9377468483\"]",
  "ibmenmailto" : "exampleString",
  "ibmenslackto": "[\"sgjhgsjaS\",\"agjhgsjaS\"]",
  "ibmensmsto" : "exampleString",
  "ibmenmms": {"content": "VBORw0KGgoAAAANSUhEUgAAAFoAAAA4CAYAAAB9lO","content_type": "image/png"},
  "ibmenhtmlbody" : "exampleString",
  "subject" : "exampleString",
  "data" : {
    "anyKey" : "anyValue"
  },
  "datacontenttype" : "application/json",
  "ibmenpushto" : "{
    \"fcm_devices\" : [ \"exampleString\" ],
    \"apns_devices\" : [ \"exampleString\" ],
    \"huawei_devices\" : [ \"exampleString\" ],
    \"safari_devices\" : [ \"exampleString\" ],
    \"chrome_devices\" : [ \"exampleString\" ],
    \"firefox_devices\" : [ \"exampleString\" ],
    \"user_ids\" : [ \"exampleString\" ],
    \"tags\" : [ \"exampleString\" ],
    \"platforms\" : [ \"push_android\" ]
  }",
  "ibmenfcmbody" : "{ }",
  "ibmenapnsbody" : "{ }",
  "ibmenapnsheaders" : "{ }",
  "ibmenchromebody" : "{ }",
  "ibmenchromeheaders" : "{ }",
  "ibmenfirefoxbody" : "{ }",
  "ibmenfirefoxheaders" : "{ }",
  "ibmenhuaweibody" : "{ }",
  "ibmensafaribody" : "{ }"
}

ibmcloud event-notifications send-notifications \
    --instance-id=exampleString \
    --body='{"specversion": "1.0", "time": "2019-01-01T12:00:00.000Z", "id": "exampleString", "source": "exampleString", "type": "exampleString", "ibmenseverity": "exampleString", "ibmensourceid": "exampleString", "ibmendefaultshort": "exampleString", "ibmendefaultlong": "exampleString", "ibmensubject": "exampleString", "ibmentemplates": [\"template-id\"], "ibmenmailto": "exampleString","ibmenslackto": "[\"sgjhgsjaS\",\"agjhgsjaS\"]", "ibmensmsto": "exampleString","ibmenmms": "{\"content\": \"VBORw0KGgoAAAANSUhEUgAAAFoAAAA4CAYAAAB9lO\",\"content_type\": \"image/png\"}", "ibmenhtmlbody": "exampleString", "subject": "exampleString", "data": {"anyKey": "anyValue"}, "datacontenttype": "application/json", "ibmenpushto": "{\"fcm_devices\": [\"exampleString\"], \"apns_devices\": [\"exampleString\"], \"huawei_devices\": [\"exampleString\"], \"safari_devices\": [\"exampleString\"], \"chrome_devices\": [\"exampleString\"], \"firefox_devices\": [\"exampleString\"], \"user_ids\": [\"exampleString\"], \"tags\": [\"exampleString\"], \"platforms\": [\"push_android\"]}", "ibmenfcmbody": "{}", "ibmenapnsbody": "{}", "ibmenapnsheaders": "{}", "ibmenchromebody": "{}", "ibmenchromeheaders": "{}", "ibmenfirefoxbody": "{}", "ibmenfirefoxheaders": "{}", "ibmenhuaweibody": "{}", "ibmensafaribody": "{}"}'