Example

ibmcloud event-notifications en-list

Command options

--instance-id (string)

The unique identifier for IBM Cloud Event Notifications instance. 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 NAME (string)

The name to be provided for API source. Required.

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 (string)

The description of the API 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 (boolean)

Enable or disable the source. Required. Set to true to enable the source.

--store-notifications (boolean)

Store notifications. Set to true to store notifications so you can view the payload of incoming events for troubleshooting purposes.

Example

ibmcloud event-notifications source-create \
   --instance-id=exampleString \
   --name=exampleString \
   --description=exampleString \
   --enabled=true \
   --store-notifications=false

Command options

--instance-id (string)

The unique identifier for IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier of the source. Required.

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

--name (string)

The updated name for the 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 (string)

The updated description for the API 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 (boolean)

Enable or disable the source.

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

--store-notifications (boolean)

Store notifications. You can view the payload of incoming events for troubleshooting purposes.

The default value is false.

Example

ibmcloud event-notifications source-update \
   --instance-id=exampleString \
   --id=exampleString \
   --name=exampleString \
   --description=exampleString \
   --enabled=true \
   --store-notifications=false

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--limit (int64)

The page limit for paginated results.

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

--offset (int64)

The offset for paginated results.

The minimum value is 0.

--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]/.

--all-pages (boolean)

Invoke multiple requests to display all pages of the source collection.

Example

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

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the source. Required.

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

Example

ibmcloud event-notifications source \
  --instance-id=exampleString \
  --id=exampleString

Command options

--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 (string)

The unique identifier for IBM Cloud Event Notifications instance. 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]/.

--force

Bypass the confirmation prompt and force the deletion of the resource.

Example

ibmcloud event-notifications source-delete \
  --instance-id=exampleString \
  --id=exampleString

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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)

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 (string)

The type of the destination. Destinations for human users: smtp_ibm, sms_ibm, smtp_custom, sms_custom, event_streams, msteams, pagerduty, push_android, push_chrome, push_firefox, push_huawei, push_ios, push_safari, servicenow, slack. Destinations for services: ibmce, ibmcos, webhook. Required.

The minimum length is 1 character.

--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-_\/.?:'";,+=!#@$%^&*() ]*/.

--collect-failed-events (boolean)

Set to true to collect failed events in a Cloud Object Storage bucket. To collect failed events, enable Cloud Object Storage integration for this instance. The default value is false.

--config (DestinationConfig examples)

The configuration for the destination. If you create a destination without --config, the destination is created but does not function until you configure it.

--certificate (string)

The certificate file path for APNs or iOS push destinations. Accepts p8 and p12 certificate files.

--certificate-content-type (string)

The content type of the certificate for iOS destinations. Allowed values are p8 and p12.

--icon16x16 (string)

The file path for the Safari icon 16x16. For push_safari destinations.

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

--icon16x16-content-type (string)

The content type of the Safari icon 16x16.

--icon16x162x (string)

The file path for the Safari icon 16x16@2x. For push_safari destinations.

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

--icon16x162x-content-type (string)

The content type of the Safari icon 16x16@2x.

--icon32x32 (string)

The file path for the Safari icon 32x32. For push_safari destinations.

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

--icon32x32-content-type (string)

The content type of the Safari icon 32x32.

--icon32x322x (string)

The file path for the Safari icon 32x32@2x. For push_safari destinations.

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

--icon32x322x-content-type (string)

The content type of the Safari icon 32x32@2x.

--icon128x128 (string)

The file path for the Safari icon 128x128. For push_safari destinations.

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

--icon128x128-content-type (string)

The content type of the Safari icon 128x128.

--icon128x1282x (string)

The file path for the Safari icon 128x128@2x. For push_safari destinations.

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

--icon128x1282x-content-type (string)

The content type of the Safari icon 128x128@2x.

Cloud Functions is no longer supported as a destination.

Examples

ibmcloud event-notifications destination-create \
  --instance-id=exampleString \
  --name=exampleString \
  --type=webhook \
  --description=exampleString \
  --collect-failed-events=false \
  --config='{"params": {"domain": "exampleString", "dkim": {"public_key": "exampleString", "selector": "exampleString", "verification": "exampleString"}, "spf": {"txt_name": "exampleString", "txt_value": "exampleString", "verification": "exampleString"}}}' \
  --certificate=tempdir/test-file.txt \
  --certificate-content-type=exampleString \
  --icon16x16=tempdir/test-file.txt \
  --icon16x16-content-type=exampleString \
  --icon16x162x=tempdir/test-file.txt \
  --icon16x162x-content-type=exampleString \
  --icon32x32=tempdir/test-file.txt \
  --icon32x32-content-type=exampleString \
  --icon32x322x=tempdir/test-file.txt \
  --icon32x322x-content-type=exampleString \
  --icon128x128=tempdir/test-file.txt \
  --icon128x128-content-type=exampleString \
  --icon128x1282x=tempdir/test-file.txt \
  --icon128x1282x-content-type=exampleString

• The following example shows format of the DestinationConfig object for iOS destination(push_ios) 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(push_ios) 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(push_chrome). 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(push_firefox). 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(slack) 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(slack) with type as direct_message.

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

• The following example shows format of the DestinationConfig object for Safari destination(push_safari). 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(msteams) destination.

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

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

  It is recommended to use only the Routing key while creating the destination. The API key is deprecated and will not available for use in the future.

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

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

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

• The following example shows the format of the DestinationConfig object for Android(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(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(ibmce) 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(ibmcos) 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(push_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(smtp_custom) destination. In case of Custom Email Sandbox(smtp_custom_sandbox) destination, Destination Configuration params are not required.

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

• The following example shows the format of the DestinationConfig object for Event Streams(event_streams) destination.

  {
     "params" : {
        "crn": "crn:v1:bluemix:public:messagehub:us-south:a/9f007405a9fe4a5d9345fa8c13357373:a292db6e-af78-4c0b-b3db-7d6794b637g::",
        "endpoint": "https://n6627w6t7dgeh2cfgd.svc09.us-south.eventstreams.cloud.ibm.com",
        "topic": "demo_topic"
     }
  }
  

• The following example shows the format of the DestinationConfig object for App Configuration(app_configuration) destination.

  {
     "params" : {
        "type": "features",
        "crn": "crn:v1:bluemix:public:apprapp:us-south:a/4a74f2c31f554afc88156b73a1d577c6:dbxxxx93-0xxa-4xx5-axcf-c2faxxxd::",
        "environment_id": "stage",
        "feature_id": "test"
     }
  }
  

  A custom SMS destination can be created without DestinationConfig, but it will not function until the required personalized numbers are explicitly requested and configured. To request personalized numbers, see Custom SMS personalized numbers.

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--limit (int64)

The page limit for paginated results.

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

--offset (int64)

The offset for paginated results.

The minimum value is 0.

--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]/.

--all-pages (boolean)

Invoke multiple requests to display all pages of the destination collection.

Example

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

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the 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]/.

Example

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

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the 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)

The updated name of the destination.

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)

The updated description of the destination.

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 (boolean)

Set to true to collect failed events in a Cloud Object Storage bucket. The default value is false.

--config (DestinationConfig)

The updated configuration for the destination.

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 (string)

The certificate file path for APNs or iOS push destinations. Accepts p8 and p12 certificate files.

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

--certificate-content-type (string)

The content type of the certificate for iOS destinations. Allowed values are p8 and p12.

--icon16x16 (string)

The file path for the Safari icon 16x16. For push_safari destinations.

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

--icon16x16-content-type (string)

The content type of the Safari icon 16x16.

--icon16x162x (string)

The file path for the Safari icon 16x16@2x. For push_safari destinations.

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

--icon16x162x-content-type (string)

The content type of the Safari icon 16x16@2x.

--icon32x32 (string)

The file path for the Safari icon 32x32. For push_safari destinations.

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

--icon32x32-content-type (string)

The content type of the Safari icon 32x32.

--icon32x322x (string)

The file path for the Safari icon 32x32@2x. For push_safari destinations.

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

--icon32x322x-content-type (string)

The content type of the Safari icon 32x32@2x.

--icon128x128 (string)

The file path for the Safari icon 128x128. For push_safari destinations.

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

--icon128x128-content-type (string)

The content type of the Safari icon 128x128.

--icon128x1282x (string)

The file path for the Safari icon 128x128@2x. For push_safari destinations.

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

--icon128x1282x-content-type (string)

The content type of the Safari icon 128x128@2x.

Example

ibmcloud event-notifications destination-update \
  --instance-id=exampleString \
  --id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --collect-failed-events=false \
  --config='{"params": {"domain": "exampleString", "dkim": {"public_key": "exampleString", "selector": "exampleString", "verification": "exampleString"}, "spf": {"txt_name": "exampleString", "txt_value": "exampleString", "verification": "exampleString"}}}' \
  --certificate=tempdir/test-file.txt \
  --certificate-content-type=exampleString \
  --icon16x16=tempdir/test-file.txt \
  --icon16x16-content-type=exampleString \
  --icon16x162x=tempdir/test-file.txt \
  --icon16x162x-content-type=exampleString \
  --icon32x32=tempdir/test-file.txt \
  --icon32x32-content-type=exampleString \
  --icon32x322x=tempdir/test-file.txt \
  --icon32x322x-content-type=exampleString \
  --icon128x128=tempdir/test-file.txt \
  --icon128x128-content-type=exampleString \
  --icon128x1282x=tempdir/test-file.txt \
  --icon128x1282x-content-type=exampleString

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the 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]/.

--force (boolean)

Force the command to run.

Example

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

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the SMS 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]/.

Example

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

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the 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]/.

Example

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

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the 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]/.

--domain (string)

The email domain. Required.

The maximum length is 250 characters. The minimum length is 1 character. The value must match regular expression /.*/.

Example

ibmcloud event-notifications sandbox-destination-update \
    --instance-id=exampleString \
    --id=exampleString \
    --domain=exampleString

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the 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]/.

--type (string)

The verification type for a custom domain email destination. Allowed values are spf and dkim. Required.

The maximum length is 20 characters. The minimum length is 1 character. The value must match regular expression /[a-z]/.

Example

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

Command options

--instance-id INSTANCE-ID (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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 NAME (string)

The 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)

The 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 SOURCES (TopicCreateSourcesItem[])

The source and filter configuration to associate with the topic. See source configuration examples.

Example

ibmcloud event-notifications topic-create \
  --instance-id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --sources='[{"id": "e7c3b3ee-78d9-4e02-95c3-c001a05e6ea5:api", "rules": [{"enabled": true, "event_type_filter": "$.notification_event_info.event_type == \'cert_manager\'", "notification_filter": "$.notification.findings[0].severity == \'MODERATE\'"}]}]'

• The following example shows the format of the TopicCreateSourcesItem[] object for the Periodic Timer source.

  [
     {
        "id" : "exampleString",
        "rules" : [
           {
              "enabled" : true,
              "event_schedule_filter": {
                 "starts_at": "2024-12-23T12:00:00.000Z",
                 "ends_at": "2024-12-23T20:00:00.000Z",
                 "expression": "* * * * *"
              }
           }
        ]
     }
  ]
  

• 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": "$.notification_event_info.event_type == \'cert_manager\'",
              "notification_filter" : "$.notification.findings[0].severity == \'MODERATE\'",
              "rule_id" : "exampleString"
           }
        ]
     }
  ]
  

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--limit (int64)

The page limit for paginated results.

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

--offset (int64)

The offset for paginated results.

The minimum value is 0.

--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]/.

--all-pages (boolean)

Invoke multiple requests to display all pages of the topic collection.

Example

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

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the 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 (string)

Include subtopics.

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

Example

ibmcloud event-notifications topic \
  --instance-id=exampleString \
  --id=exampleString \
  --include=exampleString

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the 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)

The updated 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)

The updated 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[])

The updated source details and filters. See source configuration examples.

This option adds only new sources. Sources that are already attached to the topic cannot be replaced or updated. To modify source filters, remove the source from the topic and add it again with the new filter configuration.

Example

ibmcloud event-notifications topic-update \
  --instance-id=exampleString \
  --id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --sources='[{"id": "e7c3b3ee-78d9-4e02-95c3-c001a05e6ea5:api", "rules": [{"enabled": true, "event_type_filter": "$.notification_event_info.event_type == \'cert_manager\'", "notification_filter": "$.notification.findings[0].severity == \'MODERATE\'"}]}]'

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the 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}/.

--force (boolean)

Force the command to run.

Example

ibmcloud event-notifications topic-delete \
  --instance-id=exampleString \
  --id=exampleString

Command options

--name (string)

The name of the subscription. Required.

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 (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--description (string)

The description of the 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 (string)

The destination ID to link to the topic. Required.

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 (string)

The topic ID for the subscription. Required.

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 (SubscriptionCreateAttributes)

The attributes that are required to create the subscription. See attribute examples.

Examples

ibmcloud event-notifications subscription-create \
  --instance-id=exampleString \
  --name=exampleString \
  --destination-id=exampleString \
  --topic-id=exampleString \
  --description=exampleString \
  --attributes='{"invited": ["exampleString"]}'

• 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",
  }
  

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

  {
     "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"
  }
  

• The following example shows the format of the SubscriptionCreateAttributes object for Pagerduty/Event Streams.

  {
     "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13",
  }
  

• The following example shows the format of the SubscriptionCreateAttributes object for App Configuration. When creating or updating a subscription for an App Configuration destination, the attributes object has a specific rule:

  • You must include either feature_flag_enabled or template_id_notification
  • You cannot include both properties together

  This ensures that a subscription is created for the correct use case — either feature flag evaluation or notification templating, but not both at once.

  {
     "template_id_notification": "e40843c8-xxxx-4717-xxxx-f923f2786a34",
  }
  

  {
     "feature_flag_enabled": false,
  }
  

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--offset (int64)

The offset for paginated results.

The minimum value is 0.

--limit (int64)

The page limit for paginated results.

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

--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]/.

--all-pages (boolean)

Invoke multiple requests to display all pages of the subscription collection.

Example

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

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the 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}/.

Example

ibmcloud event-notifications subscription \
  --instance-id=exampleString \
  --id=exampleString

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the 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}/.

--force (boolean)

Force the command to run.

Example

ibmcloud event-notifications subscription-delete \
  --instance-id=exampleString \
  --id=exampleString

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the 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 (string)

The updated name of the subscription.

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

--description (string)

The updated description of the 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 (SubscriptionUpdateAttributes)

The updated attributes. See attribute examples.

Examples

ibmcloud event-notifications subscription-update \
  --instance-id=exampleString \
  --id=exampleString \
  --name=exampleString \
  --description=exampleString \
  --attributes='{"invited": {"add": ["exampleString"], "remove": ["exampleString"]}, "subscribed": {"remove": ["exampleString"]}, "unsubscribed": {"remove": ["exampleString"]}}'

• 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 Custom Email Sandbox.

  {
     "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",
     "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"
  }
  

  • The following example shows the format of the SubscriptionUpdateAttributes object for Pagerduty/Event Streams.

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

  • The following example shows the format of the SubscriptionCreateAttributes object for App Configuration. When creating or updating a subscription for an App Configuration destination, the attributes object has a specific rule:

    • You must include either feature_flag_enabled or template_id_notification
    • You cannot include both properties together

    This ensures that a subscription is created for the correct use case — either feature flag evaluation or notification templating, but not both at once.

  {
     "template_id_notification": "e40843c8-xxxx-4717-xxxx-f923f2786a34",
  }
  

  {
     "feature_flag_enabled": false,
  }
  

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--type (string)

The type of integration. The supported type is collect_failed_events. Required.

The maximum length is 50 characters. The minimum length is 1 characters. Allowed value is collect_failed_events.

--metadata (string)

The integration metadata that is required to create the integration. See the example for help formatting. Required.

Examples

ibmcloud event-notifications integration-create \
  --instance-id=exampleString \
  --type=collect_failed_events \
  --metadata='{"endpoint": "exampleString", "crn": "exampleString", "bucket_name": "exampleString"}'

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

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--type (string)

The integration type. Allowed values are kms, hs-crypto, and collect_failed_events. Required.

The maximum length is 50 characters. The minimum length is 1 characters.

--metadata (string)

The integration metadata that is required to update the integration. See the example for help formatting. Required.

--id (string)

The unique identifier for the integration. Required.

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

Examples

ibmcloud event-notifications integration-update \
  --instance-id=exampleString \
  --id=exampleString \
  --type=exampleString \
  --metadata='{"endpoint": "exampleString", "crn": "exampleString", "root_key_id": "exampleString", "bucket_name": "exampleString"}'

The following example shows the format of the IntegrationReplaceAttributes object for Key Protect.

{
   "endpoint" : "https://qa.us-south.kms.cloud.ibm.com",
   "crn" : "crn of key protect",
   "root_key_id" : "root key id"
}

Command options

--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]/.

--limit (int64)

Page limit for paginated results.

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

--offset (int64)

offset for paginated results.

The minimum value is 0.

--search (string)

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]/.

--all-pages (boolean)

Invoke multiple requests to display all pages of the integration collection.

Example

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

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the integration. Required.

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

Example

ibmcloud event-notifications integration \
  --instance-id=exampleString \
  --id=exampleString

Command options

--instance-id (string)

The unique identifier for the 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]/.

--name (string)

The name of the template. 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 (string)

The template type. Supported types are smtp_custom.invitation, smtp_custom.notification, webhook.notification, slack.notification, pagerduty.notification, and event_streams.notification. Required.

The maximum length is 24 characters. The minimum length is 22 characters. The value must match regular expression /^(smtp_custom.notification|smtp_custom.invitation)$/.

--params (TemplateConfig)

The template parameters for the notification. Required. See template parameters.

This JSON option can instead be provided by setting individual fields with other options. It is mutually exclusive with those options.

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

--description (string)

The template description.

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

--params-body (string)

Template body. This option provides a value for a sub-field of the JSON option 'params'. It is mutually exclusive with that option.

The maximum length is 20000 characters. The minimum length is 1 character. The value must match regular expression /.*/.

--params-subject (string)

The template subject. This option provides a value for a sub-field of the JSON option 'params'. It is mutually exclusive with that option.

The maximum length is 1000 characters. The minimum length is 1 character. The value must match regular expression /.*/.

Examples

• The following example shows the format of the TemplateConfig object for email. The supported types are smtp_custom.notification and smtp_custom.invitation.

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

• The following example shows the format of the TemplateConfig object for Slack. The supported type is slack.notification.

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type slack.notification \
    --params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
    --description exampleString

• The following example shows the format of the TemplateConfig object for Webhook. The supported type is webhook.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type webhook.notification \
    --params '{"body": "ewoJImJsb2NrcyI6IFsKCQl7CgkJCSJ0eXBlIjogInNlY3Rpb24iLAoJCQkidGV4dCI6IHsKCQkJCSJ0eXBlIjogIm1ya2R3biIsCgkJCQkidGV4dCI6ICJOZXcgUGFpZCBUaW1lIE9mZiByZXF1ZXN0IGZyb20gPGV4YW1wbGUuY29tfEZyZWQgRW5yaXF1ZXo+XG5cbjxodHRwczovL2V4YW1wbGUuY29tfFZpZXcgcmVxdWVzdD4iCgkJCX0KCQl9CgldCn0="}' \
    --description exampleString

• The following example shows the format of the TemplateConfig object for Pagerduty. The supported type is pagerduty.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type pagerduty.notification \
    --params '{"body": "ewogICJwYXlsb2FkIjogewogICAgInN1bW1hcnkiOiAie3sgZGF0YS5hbGVydF9kZWZpbml0aW9uLm5hbWV9fSIsCiAgICAidGltZXN0YW1wIjogInt7dGltZX19IiwKICAgICJzZXZlcml0eSI6ICJpbmZvIiwKICAgICJzb3VyY2UiOiAie3sgc291cmNlIH19IgogIH0sCiAgImRlZHVwX2tleSI6ICJ7eyBpZCB9fSIsCiAge3sjZXF1YWwgZGF0YS5zdGF0dXMgInRyaWdnZXJlZCJ9fQogICJldmVudF9hY3Rpb24iOiAidHJpZ2dlciIKICAge3svZXF1YWx9fQoKICB7eyNlcXVhbCBkYXRhLnN0YXR1cyAicmVzb2x2ZWQifX0KICAiZXZlbnRfYWN0aW9uIjogInJlc29sdmUiCiAge3svZXF1YWx9fQoKICAge3sjZXF1YWwgZGF0YS5zdGF0dXMgImFja25vd2xlZGdlZCJ9fQogICAiZXZlbnRfYWN0aW9uIjogImFja25vd2xlZGdlIgogICB7ey9lcXVhbH19Cn0="}' \
    --description exampleString

• The following example shows the format of the TemplateConfig object for Event Streams. The supported type is event_streams.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type event_streams.notification \
    --params '{"body": "eyJuYW1lIjoie3tkYXRhLm5hbWV9fSIifQ=="}' \
    --description exampleString

• The following example shows the format of the TemplateConfig object for Code Engine Job. The supported type is ibmcejob.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type ibmcejob.notification\
    --params '{"body": "ewogInJ1bl9lbnZfdmFyaWFibGVzIjogWwogICB7ICJuYW1lIjogInJlZ2lvbiIsICJ2YWx1ZSI6ICJ7e2RhdGEucmVnaW9ufX0iLCJ0eXBlIjogImxpdGVyYWwifSwKeyJuYW1lIjoiVkFSMSIsInR5cGUiOiJsaXRlcmFsIiwidmFsdWUiOiJ7e2RhdGEudmFyMX19In0sCnsibmFtZSI6IlZBUjIiLCJ0eXBlIjoibGl0ZXJhbCIsInZhbHVlIjoie3tkYXRhLnZhcjJ9fSJ9Cl0KfQ=="}' \
    --description exampleString

• The following example shows the format of the TemplateConfig object for Code Engine Application/Function. The supported type is ibmceapp.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type ibmceapp.notification\
    --params '{"body": "ewogICJ2YXIxIjogInt7ZGF0YS52YXIxfX0iLAogICJ2YXIyIjogInt7ZGF0YS52YXIyfX0iCn0="}' \
    --description exampleString

• The following example shows the format of the TemplateConfig object for App Configuration. The supported type is app_configuration.notification

ibmcloud event-notifications template-create \
    --instance-id exampleString \
    --name exampleString \
    --type app_configuration.notification\
    --params '{"body": "eyJlbmFibGVkIjogZmFsc2V9Cg=="}' \
    --description exampleString

Command options

--instance-id (string)

The unique identifier for the 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]/.

--limit (int64)

The page limit for paginated results.

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

--offset (int64)

The offset for paginated results.

The default value is 0. The minimum value is 0.

--search (string)

The search string for filtering results.

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

--all-pages (boolean)

Invoke multiple requests to display all pages of the template collection.

Example

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

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. Required.

The maximum length is 32 characters. The minimum length is 32 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}/.

--id (string)

The unique identifier for the template. Required.

The maximum length is 32 characters. The minimum length is 32 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}/.

Example

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

Command options

--instance-id (string)

The unique identifier for the 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)

The unique identifier for the template. Required.

The maximum length is 32 characters. The minimum length is 32 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)

The updated template 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)

The updated template description.

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

--params (TemplateConfig)

The updated template parameters. See template parameters.

This JSON option can instead be provided by setting individual fields with other options. It is mutually exclusive with those options.

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

Examples

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

Command options

--instance-id (string)

The unique identifier for the 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)

The unique identifier for the template. Required.

The maximum length is 32 characters. The minimum length is 32 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}/.

-f, --force (boolean)

Force the command to run.

Example

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

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. Required.

The maximum length is 32 characters. The minimum length is 32 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}/.

--source (string)

The source type for the predefined template. Required.

The maximum length is 50 characters. The minimum length is 1 character. The value must match regular expression /.*/.

--type (string)

The template type for the predefined template, based on the destination. Required.

The maximum length is 50 characters. The minimum length is 1 character. The value must match regular expression /.*/.

--limit (int64)

The page limit for paginated results.

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

--offset (int64)

The offset for paginated results.

The default value is 0. The minimum value is 0.

--search (string)

The search string for filtering results.

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

--all-pages (boolean)

Invoke multiple requests to display all pages of the predefined-template collection.

Example

ibmcloud event-notifications pre-defined-templates \
  --instance-id=exampleString \
  --source=exampleString \
  --type=exampleString \
  --limit=10 \
  --offset=0 \
  --search=exampleString

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. Required.

--id (string)

The unique identifier for the predefined template. Required.

Example

ibmcloud event-notifications pre-defined-template \
  --instance-id=exampleString \
  --id=exampleString

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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)

The name of the SMTP configuration. Required.

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

--domain (string)

The domain name for the SMTP configuration. Required.

The maximum length is 512 characters. The minimum length is 1 character. The value must match regular expression /.*/.

--description (string)

The description of the SMTP configuration.

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

Example

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

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--limit (int64)

The page limit for paginated results.

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

--offset (int64)

The offset for paginated results.

The default value is 0. The minimum value is 0.

--search (string)

The search string for filtering results.

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

--all-pages (boolean)

Invoke multiple requests to display all pages of the SMTP configuration collection.

Example

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

Command options

--instance-id (string)

The unique identifier for the IBM Cloud Event Notifications instance. 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]/.

--id (string)

The unique identifier for the SMTP configuration. Required.

The maximum length is 32 characters. The minimum length is 32 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}/.

--description (string)

The description of the SMTP user.

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

--username-to-clone (string)

The username of the SMTP user to clone.

The maximum length is 20 characters. The minimum length is 1 character. The value must match regular expression /^[a-z0-9]{18}\\d{2}$/.

Example

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

Command options

--instance-id (string)

Unique identifier for IBM Cloud Event Notifications instance. 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]/.

--id (string)

Unique identifier for SMTP. Required.

The maximum length is 32 characters. The minimum length is 32 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}/.

--limit (int64)

Page limit for paginated results.

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

--offset (int64)

offset for paginated results.

The default value is 0. The minimum value is 0.

--search (string)

Search string for filtering results.

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

--all-pages (boolean)

Invoke multiple requests to display all pages of the collection for smtp-users.

Example

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

Command options

--instance-id (string)

Unique identifier for IBM Cloud Event Notifications instance. 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]/.

--id (string)

Unique identifier for SMTP. Required.

The maximum length is 32 characters. The minimum length is 32 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}/.

Example

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

Command options

--instance-id (string)

Unique identifier for IBM Cloud Event Notifications instance. 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]/.

--id (string)

Unique identifier for SMTP. Required.

The maximum length is 32 characters. The minimum length is 32 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)

SMTP name.

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

--description (string)

SMTP description.

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

Example

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

Command options

--instance-id (string)

Unique identifier for IBM Cloud Event Notifications instance. 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]/.

--id (string)

Unique identifier for SMTP. Required.

The maximum length is 32 characters. The minimum length is 32 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}/.

Example

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

Command options

--instance-id (string)

Unique identifier for IBM Cloud Event Notifications instance. 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]/.

--id (string)

Unique identifier for SMTP. Required.

The maximum length is 32 characters. The minimum length is 32 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 (string)

UserID. Required.

The maximum length is 256 characters. The minimum length is 5 characters. The value must match regular expression /.*/.

Example

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

Command options

--instance-id (string)

Unique identifier for IBM Cloud Event Notifications instance. 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]/.

--id (string)

Unique identifier for SMTP. Required.

The maximum length is 32 characters. The minimum length is 32 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 (string)

UserID. Required.

The maximum length is 256 characters. The minimum length is 5 characters. The value must match regular expression /.*/.

--description (string)

SMTP user description.

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

Example

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

Command options

--instance-id (string)

Unique identifier for IBM Cloud Event Notifications instance. 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]/.

--id (string)

Unique identifier for SMTP. Required.

The maximum length is 32 characters. The minimum length is 32 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 (string)

UserID. Required.

The maximum length is 256 characters. The minimum length is 5 characters. The value must match regular expression /.*/.

Example

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

Command options

--instance-id (string)

Unique identifier for IBM Cloud Event Notifications instance. 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]/.

--id (string)

Unique identifier for SMTP. Required.

The maximum length is 32 characters. The minimum length is 32 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}/.

Example

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

Command options

--instance-id (string)

Unique identifier for IBM Cloud Event Notifications instance. 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]/.

--id (string)

Unique identifier for SMTP. Required.

The maximum length is 32 characters. The minimum length is 32 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}/.

--type (string)

SMTP verification type. Allowed values are spf, dkim, and en_authorization. Required.

The maximum length is 20 characters. The minimum length is 1 character. The value must match regular expression /.*/.

Example

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

Command options

--instance-id (string)

Unique identifier for IBM Cloud Event Notifications instance. 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]/.

--gte (string)

GTE (greater than equal), start timestamp in UTC. Required.

The maximum length is 28 characters. The minimum length is 1 character. The value must match regular expression /[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/.

--lte (string)

LTE (less than equal), end timestamp in UTC. Required.

The maximum length is 28 characters. The minimum length is 1 character. The value must match regular expression /[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/.

--smtp-config-id (string)

SMTP configuration ID. Required when querying metrics for SMTP interface destinations.

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}/.

--destination-type (string)

Destination type for which metrics are requested. Supported value: smtp_custom. Required when querying metrics for custom email destinations.

Allowable values are: smtp_custom.

--destination-id (string)

Unique identifier for Destination.

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}/.

--subscription-id (string)

Unique identifier for Subscription.

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}/.

--source-id (string)

Unique identifier for Source.

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

--email-to (string)

Receiver email id.

The maximum length is 256 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/.

--notification-id (string)

Notification Id.

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}/.

--subject (string)

Email subject.

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

Example

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

Command options

--instance-id (string)

Unique identifier for IBM Cloud Event Notifications instance. 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}/.

--gte (string)

Greater than equal (GTE) start timestamp in UTC. Required.

The maximum length is 28 characters. The minimum length is 1 character. The value must match regular expression /[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/.

--lte (string)

Less than equal (LTE) start timestamp in UTC. Required.

The maximum length is 28 characters. The minimum length is 1 character. The value must match regular expression /[0-9]{1,4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}Z/.

--smtp-config-id (string)

SMTP configuration ID. Required when querying metrics for SMTP interface destinations.

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}/.

--destination-type (string)

Destination type for which metrics are requested. Supported value: smtp_custom. Required when querying metrics for custom email destinations.

Allowable values are: smtp_custom.

--destination-id (string)

Unique identifier for Destination.

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}/.

--subscription-id (string)

Unique identifier for Subscription.

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}/.

--source-id (string)

Unique identifier for Source.

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

--email-to (string)

Receiver email ID.

The maximum length is 256 characters. The minimum length is 0 characters. The value must match regular expression /[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}/.

--notification-id (string)

Notification ID.

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}/.

--subject (string)

Email subject.

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

--limit (int64)

Page limit for paginated results.

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

--offset (int64)

offset for paginated results.

The default value is 0. The minimum value is 0.

Example

ibmcloud event-notifications bounce-metrics \
  --instance-id=exampleString \
  --destination-type=smtp_custom \
  --gte=exampleString \
  --lte=exampleString \
  --destination-id=exampleString \
  --subscription-id=exampleString \
  --source-id=exampleString \
  --email-to=exampleString \
  --notification-id=exampleString \
  --subject=exampleString \
  --limit=10 \
  --offset=0

Command options

--instance-id (string)

Unique identifier for IBM Cloud Event Notifications instance. 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}/.

--id (string)

The notification ID returned when testing a webhook destination. This ID is specific to test notifications sent to webhook destinations. 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}/.

Example

ibmcloud event-notifications notifications-status \
  --instance-id=exampleString \
  --id=exampleString

Command options

--instance-id (string)

Unique identifier for IBM Cloud Event Notifications instance. 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]/.

--body (NotificationCreate)

Payload describing a notification create request.

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

Example

With required parameters:

ibmcloud event-notifications send-notifications \
    --instance-id=exampleString \
    --body='{"specversion": "1.0", "time": "2019-01-01T12:00:00.000Z", "type": "*", "id": "exampleString", "source": "exampleString", "ibmensourceid": "exampleString", "ibmendefaultshort": "short message", "ibmendefaultlong": "long message", "data": {"name": "exampleString"}, "datacontenttype": "application/json"}'

With all parameters:

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": "{}"}'

Additional properties that can be configured for the iOS notification

Additional properties that can be configured for the FCM notification