--- name: event-notifications-en-cli title: Event Notifications CLI description: The IBM Cloud command-line interface (CLI) provides additional capabilities for service offerings. IBM Cloud CLI supports a plug-in framework to extend its capability. You can install the Event Notifications CLI plug-in from the IBM Cloud plug-in repository. With the Event Notifications service CLI plug-in, you can easily manage Event Notifications service instances by using the CLI commands available. last-updated: 2026-08-13 --- > ## Documentation Index > The table of contents for this documentation set is at https://cloud.ibm.com/docs/event-notifications?format=markdown > The index for all IBM Cloud docs is at: https://cloud.ibm.com/docs/llms.txt > Use these files to discover more information as needed. # Event Notifications CLI {: #event-notifications-cli} The IBM Cloud command-line interface (CLI) provides additional capabilities for service offerings. IBM Cloud CLI supports a plug-in framework to extend its capability. You can install the Event Notifications CLI plug-in from the IBM Cloud plug-in repository. With the Event Notifications service CLI plug-in, you can easily manage Event Notifications service instances by using the CLI commands available. {: shortdesc} ## Prerequisites {: #en-cli-prereq} - An IBM Cloud account. If you do not have an account, click [here](https://cloud.ibm.com/) to create one. - An instance of [IBM Cloud Event Notifications](https://cloud.ibm.com/catalog/services/event-notifications) service. - [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-install-ibmcloud-cli&format=markdown) package on your local system. When you log in to the [IBM Cloud CLI](https://cloud.ibm.com/docs/cli?topic=cli-getting-started&format=markdown){: external}, you're notified when updates are available. Be sure to keep your CLI up-to-date so that you can use the commands and flags that are available for the Event Notifications CLI plug-in. {: tip} [IBM Cloud Quick Reference card](https://cloud.ibm.com/media/docs/downloads/IBM%20Cloud%20CLI%20quick%20reference.pdf). **Note** The CLI Plugin versions before 1.15.2 is deprecated {: note} ## Install the Event Notifications CLI {: #en-cli-install} Install the Event Notifications CLI plug-in by using the `plugin install` command. ```sh ibmcloud plugin install en ``` {: pre} ## Event Notifications CLI commands {: #en-cli-commands} **Note** The CLI Plugin init command will be deprecated in future ### ibmcloud en en-list {: #en-cli-list-command} Lists the instances in the set target region. You can retrieve your instance GUID from the listed instances. ```sh ibmcloud en en-list ``` {: pre} ### ibmcloud event-notifications environment variables set {: #en-cli-environment-variables} Set the region that you'll be working on by setting the ibmcloud target region ibmcloud target -r or export regional endpoint via variable IBMCLOUD_EN_ENDPOINT, for example, use the following 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` - **Osaka:** `https://jp-osa.event-notifications.cloud.ibm.com/event-notifications` - **Tokyo:** `https://jp-tok.event-notifications.cloud.ibm.com/event-notifications` - **Toronto:** `https://ca-tor.event-notifications.cloud.ibm.com/event-notifications` - **Sao Paulo:** `https://br-sao.event-notifications.cloud.ibm.com/event-notifications` - **Montreal:** `https://ca-mon.event-notifications.cloud.ibm.com/event-notifications` - **Washington DC:** `https://us-east.event-notifications.cloud.ibm.com/event-notifications` - **Chennai:** `https://in-che.event-notifications.cloud.ibm.com/event-notifications` - **Mumbai:** `https://in-mum.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` - **Osaka:** `https://private.jp-osa.event-notifications.cloud.ibm.com/event-notifications` - **Tokyo:** `https://private.jp-tok.event-notifications.cloud.ibm.com/event-notifications` - **Toronto:** `https://private.ca-tor.event-notifications.cloud.ibm.com/event-notifications` - **Sao Paulo:** `https://private.br-sao.event-notifications.cloud.ibm.com/event-notifications` - **Montreal:** `https://private.ca-mon.event-notifications.cloud.ibm.com/event-notifications` - **Washington DC:** `https://private.us-east.event-notifications.cloud.ibm.com/event-notifications` - **Chennai:** `https://private.in-che.event-notifications.cloud.ibm.com/event-notifications` - **Mumbai:** `https://private.in-mum.event-notifications.cloud.ibm.com/event-notifications` - export **EVENT_NOTIFICATIONS_API_KEY** variable to set the Event Notifications instance `apikey`. EVENT_NOTIFICATIONS_API_KEY can be your IBM Cloud API key or the service credentials API key from your Event Notifications instance. {: note} ## Sources {: #en-cli-source} Operate on IBM Cloud Event Notifications source. ### ibmcloud event-notifications sources create {: #en-cli-source-create-command} - **Action:** Create `Source`. The CLI currently supports creating API sources only. {: note} ```sh ibmcloud event-notifications sources-create --instance-id INSTANCE-ID --name NAME [--description DESCRIPTION] [--enabled ENABLED] [--store-notifications STORE-NOTIFICATIONS] ``` {: pre} You can also use the following command (both commands are currently supported): ```sh ibmcloud event-notifications source-create --instance-id INSTANCE-ID --name NAME [--description DESCRIPTION] [--enabled ENABLED] [--store-notifications STORE-NOTIFICATIONS] ``` {: pre} Both `source-create` and `sources-create` are supported. Use `source-create` for consistency with other commands. {: note} - **Parameters to provide:** `--instance-id 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` (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. Optional. 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. Optional. The value is set to true to enable the source and false to disable the source. `--store-notifications` (bool) : Enable to view the payload of incoming events for troubleshooting. The default value is `false`. ### ibmcloud event-notifications source update {: #en-cli-source-update-command} - **Action:** Update `Source`. ```sh ibmcloud event-notifications source-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--enabled ENABLED] [--store-notifications STORE-NOTIFICATIONS] ``` {: pre} - **Parameters to provide:** `--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]/`. `--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. `--store-notifications` (bool) : enable to view the payload of incoming events for troubleshooting. The default value is `false`. `--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 {: #en-cli-source-list-command} - **Action:** List all `Source`. ```sh ibmcloud event-notifications sources [--limit LIMIT] [--offset OFFSET] [--search SEARCH] --instance-id INSTANCE-ID ``` {: pre} - **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. 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]` : Activate to force resource deletion (to bypass the confirmation prompt). ### ibmcloud event-notifications source get {: #en-cli-source-get-command} - **Action:** Get specific `Source`. ```sh ibmcloud event-notifications source --id ID --instance-id INSTANCE-ID ``` {: pre} - **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. 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]` : Activate to force resource deletion (to bypass the confirmation prompt). ### ibmcloud event-notifications source delete {: #en-cli-source-delete-command} - **Action:** Delete specific `Source`. ```sh ibmcloud event-notifications source-delete --instance-id INSTANCE-ID --id ID ``` {: pre} - **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. 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]` : Activate to force resource deletion (to bypass the confirmation prompt). ## Destinations {: #en-cli-destination} Operate on IBM Cloud Event Notifications destination. ### ibmcloud event-notifications destination create {: #en-cli-destination-create} - **Action:** Create a destination. ```sh 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] ``` {: pre} - **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,push_chrome,push_firefox,push_huawei,push_safari,ibmce, ibmcos,msteams,pagerduty,servicenow,slack,smtp_custom,sms_custom, event_streams. Required. Allowable values are: `webhook`, `push_android`, `push_ios`,`push_chrome`,`push_firefox`,`push_huawei`,`push_safari`,`ibmce`, `ibmcos`,`msteams`,`pagerduty`,`servicenow`,`slack`,`smtp_custom`,`sms_custom`,event_streams. 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](#en-cli-destination-config-example-schema)) : The configuration needed to set the destination-specific parameters. If you create a destination without `--config`, the destination is created but does not function until you configure it. `--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. ```json { "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 {: #en-cli-destination-config-example-schema} - 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*: ```json { "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*. ```json { "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*. ```json { "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*. ```json { "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. ```json { "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. ```json { "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*. ```json { "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. ```json { "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. {: attention} ```json { "params" : { "routing_key" : "routingkeytoconnecttoPD", "api_key" : "cffunctionnamespaceserviceidapikey" } } ``` - The following example shows the format of the `DestinationConfig` object for Webhook(webhook). ```json { "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. ```json { "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. ```json { "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 ```json { "params" : { "type" : "application", "url" : "https://codeengine.test.com", "verb" : "get", "custom_headers" : { }, "sensitive_headers" : [ "exampleString" ] } } ``` code engine destination type: job ```json { "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. ```json { "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. ```json { "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: ```json { "params" : { "domain": "mailx.com" } } ``` - The following example shows the format of the `DestinationConfig` object for Event Streams(event_streams) destination. ```json { "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. ```json { "params" : { "type": "features", "crn": "crn:v1:bluemix:public:apprapp:us-south:a/4a74f2c31f554afc88156b73a1d577c6:dbxxxx93-0xxa-4xx5-axcf-c2faxxxd::", "environment_id": "stage", "feature_id": "test" } } ``` Note: 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](https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-destinations-sms-custom&format=markdown#en-destinations-sms-custom-numbers). ### ibmcloud event-notifications destination list {: #en-cli-destination-list-command} - **Action:** List all `Destination`. ```sh ibmcloud event-notifications destinations [--limit LIMIT] [--offset OFFSET] [--search SEARCH] --instance-id INSTANCE-ID ``` {: pre} - **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 {: #en-cli-destination-get-command} - **Action:** Get specific `Destination`. ```sh ibmcloud event-notifications destination --id ID --instance-id INSTANCE-ID ``` {: pre} - **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. 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]/`. ### ibmcloud event-notifications destination update {: #en-cli-destination-update-command} - **Action:** Update existing `Destination`. ```sh 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] ``` {: pre} - **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`](#en-cli-destination-config-example-schema)) : 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 {: #en-cli-destination-delete-command} - **Action:** Delete existing `Destination`. ```sh ibmcloud event-notifications destination-delete --id ID --instance-id INSTANCE-ID [--force] ``` {: pre} - **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. 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) : Activate to force resource deletion (to bypass the confirmation prompt). {: pre} ### `ibmcloud event-notifications enabled-countries` {: #event-notifications-cli-enabled-countries-command} Get enabled country details of SMS destination. ```sh ibmcloud event-notifications enabled-countries --instance-id INSTANCE-ID --id ID ``` #### Command options {: #event-notifications-enabled-countries-cli-options} `--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]/`. #### Example {: #event-notifications-enabled-countries-examples} ```sh ibmcloud event-notifications enabled-countries \ --instance-id=exampleString \ --id=exampleString ``` {: pre} ### `ibmcloud event-notifications test-destination` {: #event-notifications-cli-test-destination-command} Test a Destination. ```sh ibmcloud event-notifications test-destination --instance-id INSTANCE-ID --id ID ``` #### Command options {: #event-notifications-test-destination-cli-options} `--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]/`. #### Example {: #event-notifications-test-destination-examples} ```sh ibmcloud event-notifications test-destination \ --instance-id=exampleString \ --id=exampleString ``` {: pre} ### `ibmcloud event-notifications email-sandbox-destination-update` {: #event-notifications-cli-email-sandbox-destination-update-command} Upgrade sandbox destination to production with custom domain. ```sh ibmcloud event-notifications email-sandbox-destination-update --instance-id INSTANCE-ID --id ID --domain DOMAIN ``` #### Command options {: #event-notifications-email-sandbox-destination-update-cli-options} `--instance-id` (string) : Unique identifier for 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) : Unique identifier for Destination. Required. The maximum length is `36` characters. The minimum length is `36` characters. The value must match regular expression `/^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$/`. `--domain` (string) : Email Domain. Required. The maximum length is `250` characters. The minimum length is `1` character. The value must match regular expression `/.*/`. #### Example {: #event-notifications-email-sandbox-destination-update-examples} ```sh ibmcloud event-notifications email-sandbox-destination-update \ --instance-id=exampleString \ --id=exampleString \ --domain=exampleString ``` {: pre} ### `ibmcloud event-notifications verify-destination-update` {: #event-notifications-cli-verify-destination-update-command} Verify SPF and DKIM records of custom domain. ```sh ibmcloud event-notifications verify-destination-update --instance-id INSTANCE-ID --id ID --type TYPE ``` #### Command options {: #event-notifications-verify-destination-update-cli-options} `--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]/`. `--type` (string) : Verification type. Required. The maximum length is `20` characters. The minimum length is `1` character. The value must match regular expression `/[a-z]/`. #### Example {: #event-notifications-verify-destination-update-examples} ```sh ibmcloud event-notifications verify-destination-update \ --instance-id exampleString \ --id exampleString \ --type exampleString ``` {: pre} ## Topics {: #en-cli-topic} Operate on IBM Cloud Event Notifications topic. ### ibmcloud event-notifications topic create {: #en-cli-topic-create-command} - **Action:** Create new `Topic`. ```sh ibmcloud event-notifications topic-create --name NAME [--description DESCRIPTION] [--sources SOURCES] --instance-id INSTANCE-ID ``` {: pre} - **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. 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]/`. `[--sources SOURCES]` ([TopicCreateSourcesItem[]](#en-cli-topic-example-schema)) : List of sources with their filter configurations to attach to this topic. This is not just a list of source IDs — each entry includes the source ID and filter rules that determine which events from that source are routed to this topic. See the [examples](#en-cli-topic-example-schema) for the complete structure. #### Example {: #en-cli-topic-example-schema} - The following example shows the format of the `TopicCreateSourcesItem[]` object for the Periodic Timer source. ```json [ { "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. ```json [ { "id" : "exampleString", "rules" : [ { "enabled" : true, "event_type_filter" : "$.*", "notification_filter" : "exampleString" } ] } ] ``` - The following example shows the format of the `TopicUpdateSourcesItem[]` object. ```json [ { "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" } ] } ] ``` ### ibmcloud event-notifications topic list {: #en-cli-topic-list-command} - **Action:** List all `Topic`. ```sh ibmcloud event-notifications topics [--limit LIMIT] [--offset OFFSET] [--search SEARCH] --instance-id INSTANCE-ID ``` {: pre} - **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. 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]/`. ### ibmcloud event-notifications topic get {: #en-cli-topic-get-command} - **Action:** Get specific `Topic`. ```sh ibmcloud event-notifications topic --id ID [--include INCLUDE] --instance-id INSTANCE-ID ``` {: pre} - **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. 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]/`. ### ibmcloud event-notifications topic replace {: #en-cli-topic-update-command} - **Action:** Update existing `Topic`. You can use `topic-update` instead of `topic-replace`. Both commands are currently supported, but `topic-replace` will be deprecated in a future release. {: note} ```sh ibmcloud event-notifications topic-replace --id ID [--name NAME] [--description DESCRIPTION] [--sources SOURCES] --instance-id INSTANCE-ID ``` {: pre} or ```sh ibmcloud event-notifications topic-update --id ID [--name NAME] [--description DESCRIPTION] [--sources SOURCES] --instance-id INSTANCE-ID ``` {: pre} - **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[]](#en-cli-topic-example-schema)) : List of new sources with their filter configurations to add to this topic. This is not just a list of source IDs — each entry includes the source ID and filter rules that determine which events from that source are routed to this topic. See the [examples](#en-cli-topic-example-schema) for the complete structure. This flag adds new sources only. Sources already attached to the topic cannot be replaced or updated — they can only be deleted and re-added. To modify source filters, remove the source from the topic first and then add it back with the new filter configuration. {: important} ### ibmcloud event-notifications topic delete {: #en-cli-topic-delete-command} - **Action:** Delete existing `Topic`. ```sh ibmcloud event-notifications topic-delete --id ID --instance-id INSTANCE-ID [--force] ``` {: pre} - **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. 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) : Activate to force resource deletion (to bypass the confirmation prompt). ## Subscriptions {: #en-cli-subscription} Operate on IBM Cloud Event Notifications subscription. ### ibmcloud event-notifications subscription create {: #en-cli-subscription-create-command} - **Action:** Create new `Subscription`. ```sh ibmcloud event-notifications subscription-create --instance-id INSTANCE-ID --name NAME --destination-id DESTINATION-ID --topic-id TOPIC-ID [--description DESCRIPTION] [--attributes ATTRIBUTES] ``` {: pre} - **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](#en-cli-subscription-example-schema)) : The attributes to be set for subscription. #### Examples {: #en-cli-subscription-example-schema} - The following example shows the format of the `SubscriptionCreateAttributes` object for webhook. ```json { "signing_enabled" : true, "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724axx58b13" } ``` - The following example shows the format of the `SubscriptionCreateAttributes` object for SMS. ```json { "invited" :["+1xxxxxxxxxx", "+1xxxxxxxxxx"] } ``` - The following example shows the format of the `SubscriptionCreateAttributes` object for IBM Email. ```json { "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. ```json { "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. ```json { "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. ```json { "assigned_to" : "serviceuser@gmail.com", "assignment_group" : "incidentgroup" } ``` - The following example shows the format of the `SubscriptionCreateAttributes` object for Custom Email. ```json { "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. ```json { "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. ```json { "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. ```json { "template_id_notification": "e40843c8-xxxx-4717-xxxx-f923f2786a34", } ``` ```json { "feature_flag_enabled": false, } ``` ### ibmcloud event-notifications subscription list {: #en-cli-subscription-list-command} - **Action:** List all `Subscription`. ```sh ibmcloud event-notifications subscriptions [--offset OFFSET] [--limit LIMIT] [--search SEARCH] --instance-id INSTANCE-ID ``` {: pre} - **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. 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]/`. ### ibmcloud event-notifications subscription get {: #en-cli-subscription-get-command} - **Action:** Get specific `Subscription`. ```sh ibmcloud event-notifications subscription --id ID --instance-id INSTANCE-ID ``` {: pre} - **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. 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]/`. ### ibmcloud event-notifications subscription delete {: #en-cli-subscription-delete-command} - **Action:** Delete existing `Subscription`. ```sh ibmcloud event-notifications subscription-delete --id ID --instance-id INSTANCE-ID [--force] ``` {: pre} - **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. 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) : Activate to force resource deletion (to bypass the confirmation prompt). ### ibmcloud event-notifications subscription update {: #en-cli-subscription-update-command} - **Action:** Update existing `Subscription`. ```sh ibmcloud event-notifications subscription-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--attributes ATTRIBUTES] ``` {: pre} - **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. 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 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](#en-cli-subscription-update-example-schema)) : The attributes to be set for subscription #### Examples {: #en-cli-subscription-update-example-schema} - The following example shows the format of the `SubscriptionUpdateAttributes` object for Webhook. ```json { "signing_enabled": true } ``` - The following example shows the format of the `SubscriptionUpdateAttributes` object for IBM SMS. ```json { "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. ```json { "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. ```json { "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. ```json { "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`. ```json { "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`. ```json { "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. ```json { "assigned_to" : "serviceuser@gmail.com", "assignment_group" : "incidentgroup" } ``` - The following example shows the format of the `SubscriptionUpdateAttributes` object for Pagerduty/Event Streams. ```json { "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. ```json { "template_id_notification": "e40843c8-xxxx-4717-xxxx-f923f2786a34", } ``` ```json { "feature_flag_enabled": false, } ``` ## Integrations {: #en-cli-integration} Operate on IBM Cloud Event Notifications integration. ### ibmcloud event-notifications integration Create {: #en-cli-integration-create-command} ```sh ibmcloud event-notifications integration-create --instance-id INSTANCE-ID --type TYPE --metadata METADATA ``` #### Command options {: #en-cli-integration-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]/`. `--type` (string) : Type of the integration collect_failed_events. The maximum length is `50` characters. The minimum length is `1` characters. Allowed value is collect_failed_events. `--metadata` ([IntegrationCreateAttributes](#en-cli-integration-create-example-schema)) : Integration schema for update Metadata required for integration. #### Examples {: #en-cli-integration-create-example-schema} - The following example shows the format of the `IntegrationCreateAttributes` object. ```json { "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 replace {: #en-cli-integration-update-command} Replace `Integration`. Use `integration-update` instead of `integration-replace`. Both commands are currently supported, but `integration-replace` will be deprecated in a future release. {: note} ```sh ibmcloud event-notifications integration-replace --instance-id INSTANCE-ID --id ID --type Type --metadata METADATA ``` or ```sh ibmcloud event-notifications integration-update --instance-id INSTANCE-ID --id ID --type Type --metadata METADATA ``` #### Command options {: #en-cli-integration-replace-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]/`. `--type` (string) : Type of the integration KMS/hs-crypto(deprecated). The maximum length is `50` characters. The minimum length is `1` characters. Allowed values are KMS and collect_failed_events. Note: The type hs-crypto is deprecated now. No new integration resources with hs-crypto type will be supported. `--metadata` ([IntegrationReplaceAttributes](#en-cli-integration-example-schema)) : Integration schema for update Metadata required for integration. `--id` (string) : Unique identifier for 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 {: #en-cli-integration-example-schema} - The following example shows the format of the `IntegrationReplaceAttributes` object for kms. ```json { "endpoint" : "https://qa.us-south.kms.cloud.ibm.com", "crn" : "crn of key protect", "root_key_id" : "root key id" } ``` ### ibmcloud event-notifications integration list {: #en-cli-integration-list-command} List all `Integrations`. ```sh ibmcloud event-notifications integrations [--limit LIMIT] [--offset OFFSET] [--search SEARCH] --instance-id INSTANCE-ID ``` #### Command options {: #event-notifications-Integration-list-cli-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]/`. ### ibmcloud event-notifications Integration get {: #en-cli-integration-get-command} Get specific `Integration`. ```sh ibmcloud event-notifications integration --id ID --instance-id INSTANCE-ID ``` #### Command options {: #en-cli-integration-get-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]/`. `--id` (string) : Unique identifier for integration. Required. The maximum length is `100` characters. The minimum length is `1` character. The value must match regular expression `/[a-zA-Z0-9-:_]*/`. ## Templates {: #event-notifications-templates-cli} IBM Cloud Event Notifications Templates. ### `ibmcloud event-notifications template-create` {: #event-notifications-cli-template-create-command} Create a new Template. ```sh ibmcloud event-notifications template-create --instance-id INSTANCE-ID --name NAME --type TYPE --params PARAMS [--description DESCRIPTION] ``` #### Command options {: #event-notifications-template-create-cli-options} `--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]/`. `--name` (string) : The Message 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 type of template. 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`](#event-notifications-template-create-examples)) : Payload describing a template configuration. Required. 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 {: #event-notifications-template-create-examples} - The following example shows the format of the `TemplateConfig` object for Email. The supported type is `smtp_custom.notification|smtp_custom.invitation` ```sh ibmcloud event-notifications template-create \ --instance-id exampleString \ --name exampleString \ --type smtp_custom.notification \ --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`. ```sh 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` ```sh 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` ```sh 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` ```sh 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` ```sh 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` ```sh 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` ```sh ibmcloud event-notifications template-create \ --instance-id exampleString \ --name exampleString \ --type app_configuration.notification\ --params '{"body": "eyJlbmFibGVkIjogZmFsc2V9Cg=="}' \ --description exampleString ``` {: pre} ### `ibmcloud event-notifications templates` {: #event-notifications-cli-templates-command} List all user-defined Templates. Note: If the `--all-pages` option is not set, the command will only retrieve a single page of the collection. ```sh ibmcloud event-notifications templates --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH] ``` #### Command options {: #event-notifications-templates-cli-options} `--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]/`. `--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` (bool) : Invoke multiple requests to display all pages of the collection for templates. #### Example {: #event-notifications-templates-examples} ```sh ibmcloud event-notifications templates \ --instance-id exampleString \ --limit 10 \ --offset 0 \ --search exampleString ``` {: pre} ### `ibmcloud event-notifications template` {: #event-notifications-cli-template-command} Get details of a Template. ```sh ibmcloud event-notifications template --instance-id INSTANCE-ID --id ID ``` {: pre} #### Command options {: #event-notifications-template-cli-options} `--instance-id` (string) : Unique identifier for 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) : Unique identifier for 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 {: #event-notifications-template-examples} ```sh ibmcloud event-notifications template \ --instance-id=exampleString \ --id=exampleString ``` {: pre} ### `ibmcloud event-notifications template-replace` {: #event-notifications-cli-template-update-command} Update details of a Template. ```sh ibmcloud event-notifications template-replace --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] [--params PARAMS] ``` You can use `template-update` instead of `template-replace`. Both commands are currently supported, but `template-replace` will be deprecated in a future release. {: note} #### Command options {: #event-notifications-template-update-cli-options} `--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 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) : 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) : 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`](#event-notifications-template-examples)) : Payload describing a template configuration. 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 {: #event-notifications-template-replace-examples} ```sh ibmcloud event-notifications template-replace \ --instance-id exampleString \ --id exampleString \ --name exampleString \ --description exampleString \ --type exampleString \ --params '{"body": "exampleString", "subject": "exampleString"}' ``` {: pre} or ```sh ibmcloud event-notifications template-update \ --instance-id exampleString \ --id exampleString \ --name exampleString \ --description exampleString \ --params '{"body": "exampleString", "subject": "exampleString"}' ``` {: pre} ### `ibmcloud event-notifications template-delete` {: #event-notifications-cli-template-delete-command} Delete a Template. ```sh ibmcloud event-notifications template-delete --instance-id INSTANCE-ID --id ID ``` #### Command options {: #event-notifications-template-delete-cli-options} `--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 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 {: #event-notifications-template-delete-examples} ```sh ibmcloud event-notifications template-delete \ --instance-id exampleString \ --id exampleString ``` {: pre} ### `ibmcloud event-notifications pre-defined-templates` {: #event-notifications-cli-pre-defined-templates-command} List all predefined templates. If the `--all-pages` option is not set, the command will only retrieve a single page of the collection. {: note} ```sh ibmcloud event-notifications pre-defined-templates --instance-id INSTANCE-ID --source SOURCE --type TYPE [--limit LIMIT] [--offset OFFSET] [--search SEARCH] ``` {: pre} #### Command options {: #event-notifications-pre-defined-templates-cli-options} `--instance-id` (string) : Unique identifier for 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) : Source type. Required. The maximum length is `50` characters. The minimum length is `1` character. The value must match regular expression `/.*/`. `--type` (string) : Destination type. Required. The maximum length is `50` characters. The minimum length is `1` character. The value must match regular expression `/.*/`. `--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` (bool) : Invoke multiple requests to display all pages of the collection for pre-defined-templates. #### Example {: #event-notifications-pre-defined-templates-examples} ```sh ibmcloud event-notifications pre-defined-templates \ --instance-id=exampleString \ --source=exampleString \ --type=exampleString \ --limit=10 \ --offset=0 \ --search=exampleString ``` {: pre} ## SMTP Configurations {: #event-notifications-smtp-configurations-cli} IBM Cloud Event Notifications SMTP Configurations. ### `ibmcloud event-notifications smtp-configuration-create` {: #event-notifications-cli-smtp-configuration-create-command} Create a new SMTP Configuration. ```sh ibmcloud event-notifications smtp-configuration-create --instance-id INSTANCE-ID --name NAME --domain DOMAIN [--description DESCRIPTION] ``` #### Command options {: #event-notifications-smtp-configuration-create-cli-options} `--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]/`. `--name` (string) : The name of 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) : Domain Name. Required. The maximum length is `512` characters. The minimum length is `1` character. The value must match regular expression `/.*/`. `--description` (string) : The description of 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 {: #event-notifications-smtp-configuration-create-examples} ```sh ibmcloud event-notifications smtp-configuration-create \ --instance-id=exampleString \ --name=exampleString \ --domain=exampleString \ --description=exampleString ``` {: pre} ### `ibmcloud event-notifications smtp-configurations` {: #event-notifications-cli-smtp-configurations-command} List all SMTP Configurations. Note: If the `--all-pages` option is not set, the command will only retrieve a single page of the collection. ```sh ibmcloud event-notifications smtp-configurations --instance-id INSTANCE-ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH] ``` #### Command options {: #event-notifications-smtp-configurations-cli-options} `--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]/`. `--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` (bool) : Invoke multiple requests to display all pages of the collection for smtp-configurations. #### Example {: #event-notifications-smtp-configurations-examples} ```sh ibmcloud event-notifications smtp-configurations \ --instance-id=exampleString \ --limit=10 \ --offset=0 \ --search=exampleString ``` {: pre} ### `ibmcloud event-notifications smtp-user-create` {: #event-notifications-cli-smtp-user-create-command} Create a new SMTP User. ```sh ibmcloud event-notifications smtp-user-create --instance-id INSTANCE-ID --id ID [--description DESCRIPTION] [--username-to-clone USERNAME-TO-CLONE] ``` #### Command options {: #event-notifications-smtp-user-create-cli-options} `--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 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}/`. `--description` (string) : The description of SMTP configuration. 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) : provide name of the 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 {: #event-notifications-smtp-user-create-examples} ```sh ibmcloud event-notifications smtp-user-create \ --instance-id=exampleString \ --id=exampleString \ --description=exampleString \ --username-to-clone=exampleString ``` {: pre} ### `ibmcloud event-notifications smtp-users` {: #event-notifications-cli-smtp-users-command} List all SMTP users. Note: If the `--all-pages` option is not set, the command will only retrieve a single page of the collection. ```sh ibmcloud event-notifications smtp-users --instance-id INSTANCE-ID --id ID [--limit LIMIT] [--offset OFFSET] [--search SEARCH] ``` #### Command options {: #event-notifications-smtp-users-cli-options} `--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 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` (bool) : Invoke multiple requests to display all pages of the collection for smtp-users. #### Example {: #event-notifications-smtp-users-examples} ```sh ibmcloud event-notifications smtp-users \ --instance-id=exampleString \ --id=exampleString \ --limit=10 \ --offset=0 \ --search=exampleString ``` {: pre} ### `ibmcloud event-notifications smtp-configuration` {: #event-notifications-cli-smtp-configuration-command} Get details of a SMTP Configuration. ```sh ibmcloud event-notifications smtp-configuration --instance-id INSTANCE-ID --id ID ``` {: pre} #### Command options {: #event-notifications-smtp-configuration-cli-options} `--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 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 {: #event-notifications-smtp-configuration-examples} ```sh ibmcloud event-notifications smtp-configuration \ --instance-id=exampleString \ --id=exampleString ``` {: pre} ### `ibmcloud event-notifications smtp-configuration-update` {: #event-notifications-cli-smtp-configuration-update-command} Update details of SMTP. ```sh ibmcloud event-notifications smtp-configuration-update --instance-id INSTANCE-ID --id ID [--name NAME] [--description DESCRIPTION] ``` {: pre} #### Command options {: #event-notifications-smtp-configuration-update-cli-options} `--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 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 {: #event-notifications-smtp-configuration-update-examples} ```sh ibmcloud event-notifications smtp-configuration-update \ --instance-id=exampleString \ --id=exampleString \ --name=exampleString \ --description=exampleString ``` {: pre} ### `ibmcloud event-notifications smtp-configuration-delete` {: #event-notifications-cli-smtp-configuration-delete-command} Delete a SMTP Configuration. ```sh ibmcloud event-notifications smtp-configuration-delete --instance-id INSTANCE-ID --id ID ``` #### Command options {: #event-notifications-smtp-configuration-delete-cli-options} `--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 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 {: #event-notifications-smtp-configuration-delete-examples} ```sh ibmcloud event-notifications smtp-configuration-delete \ --instance-id=exampleString \ --id=exampleString ``` {: pre} ### `ibmcloud event-notifications smtp-user` {: #event-notifications-cli-smtp-user-command} Get details of a SMTP User. ```sh ibmcloud event-notifications smtp-user --instance-id INSTANCE-ID --id ID --user-id USER-ID ``` #### Command options {: #event-notifications-smtp-user-cli-options} `--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 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 {: #event-notifications-smtp-user-examples} ```sh ibmcloud event-notifications smtp-user \ --instance-id=exampleString \ --id=exampleString \ --user-id=exampleString ``` {: pre} ### `ibmcloud event-notifications smtp-user-update` {: #event-notifications-cli-smtp-user-update-command} Update details of SMTP User. ```sh ibmcloud event-notifications smtp-user-update --instance-id INSTANCE-ID --id ID --user-id USER-ID [--description DESCRIPTION] ``` #### Command options {: #event-notifications-smtp-user-update-cli-options} `--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 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 {: #event-notifications-smtp-user-update-examples} ```sh ibmcloud event-notifications smtp-user-update \ --instance-id=exampleString \ --id=exampleString \ --user-id=exampleString \ --description=exampleString ``` {: pre} ### `ibmcloud event-notifications smtp-user-delete` {: #event-notifications-cli-smtp-user-delete-command} Delete a SMTP user. ```sh ibmcloud event-notifications smtp-user-delete --instance-id INSTANCE-ID --id ID --user-id USER-ID ``` #### Command options {: #event-notifications-smtp-user-delete-cli-options} `--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 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 {: #event-notifications-smtp-user-delete-examples} ```sh ibmcloud event-notifications smtp-user-delete \ --instance-id=exampleString \ --id=exampleString \ --user-id=exampleString ``` {: pre} ### `ibmcloud event-notifications smtp-allowed-ips` {: #event-notifications-cli-smtp-allowed-ips-command} Get details of a SMTP allowed IPs. ```sh ibmcloud event-notifications smtp-allowed-ips --instance-id INSTANCE-ID --id ID ``` #### Command options {: #event-notifications-smtp-allowed-ips-cli-options} `--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 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 {: #event-notifications-smtp-allowed-ips-examples} ```sh ibmcloud event-notifications smtp-allowed-ips \ --instance-id=exampleString \ --id=exampleString ``` {: pre} ### `ibmcloud event-notifications smtp-allowed-ips-update` {: #event-notifications-cli-smtp-allowed-ips-update-command} Note: The support for legacy allowlisting has been deprecated. The support has been enabled via Context-based-restrictions. For detailed information, please refer here: ### `ibmcloud event-notifications verify-smtp-update` {: #event-notifications-cli-verify-smtp-update-command} Verify SPF and DKIM records of SMTP. ```sh ibmcloud event-notifications verify-smtp-update --instance-id INSTANCE-ID --id ID --type TYPE ``` #### Command options {: #event-notifications-verify-smtp-update-cli-options} `--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 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. Required. The maximum length is `20` characters. The minimum length is `1` character. The value must match regular expression `/.*/`. #### Example {: #event-notifications-verify-smtp-update-examples} ```sh ibmcloud event-notifications verify-smtp-update \ --instance-id=exampleString \ --id=exampleString \ --type=exampleString ``` {: pre} ## Metrics {: #event-notifications-metrics-cli} ### `ibmcloud event-notifications metrics` {: #event-notifications-cli-metrics-command} Get metrics. ```sh ibmcloud event-notifications metrics ---instance-id INSTANCE-ID --gte GTE --lte LTE [--smtp-config-id SMTP-CONFIG-ID] [--destination-type DESTINATION-TYPE][--destination-id DESTINATION-ID] [--subscription-id SUBSCRIPTION-ID] [--source-id SOURCE-ID] [--email-to EMAIL-TO] [--notification-id NOTIFICATION-ID] [--subject SUBJECT] ``` #### Command options {: #event-notifications-metrics-cli-options} `--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]/`. `--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 {: #event-notifications-metrics-examples} ```sh 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 ``` {: pre} ### `ibmcloud event-notifications bounce-metrics` {: #event-notifications-cli-bounce-metrics-command} Get bounce metrics. ```sh ibmcloud event-notifications bounce-metrics --instance-id INSTANCE-ID --gte GTE --lte LTE [--smtp-config-id SMTP-CONFIG-ID] [--destination-type DESTINATION-TYPE] [--destination-id DESTINATION-ID] [--subscription-id SUBSCRIPTION-ID] [--source-id SOURCE-ID] [--email-to EMAIL-TO] [--notification-id NOTIFICATION-ID] [--subject SUBJECT] [--limit LIMIT] [--offset OFFSET] ``` #### Command options {: #event-notifications-bounce-metrics-cli-options} `--instance-id` (string) : Unique identifier for 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}/`. `--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]/`. `--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 {: #event-notifications-bounce-metrics-examples} ```sh 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 ``` {: pre} ## Get Notifications Status {: #event-notifications-get-notifications-status-cli} This document describes the payload details for getting Notification status for Webhook Destination Test notifications. ### `ibmcloud event-notifications notifications-status` {: #event-notifications-cli-notifications-status-command} Get the status of a test notification sent to a webhook destination. This command is specifically used to retrieve the delivery status of webhook test notifications. ```sh ibmcloud event-notifications notifications-status --instance-id INSTANCE-ID --id ID ``` #### Command options {: #event-notifications-notifications-status-cli-options} `--instance-id` (string) : Unique identifier for 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 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 {: #event-notifications-notifications-status-examples} ```sh ibmcloud event-notifications notifications-status \ --instance-id=exampleString \ --id=exampleString ``` {: pre} ## Send Notifications {: #event-notifications-send-notifications-cli} This document describes the payload details for sending events using the API sources in Event Notifications. API sources can be used to send events from your backend applications. Event Notifications supports two modes to make HTTP calls. This is adhering to the CloudEvents specification. These modes are Binary Mode and Structured mode. More details here - . In the Binary Content Mode, the value of the event data is placed into the HTTP request, or response, body as-is, with the datacontenttype attribute value declaring its media type in the HTTP Content-Type header; all other event attributes are mapped to HTTP headers. All the attribute names are prefixed with ce- and added to the header (except for the data and datacontenttype). When mandatory attributes of CloudEvents (specversion, id, type, and source) are passed as part of headers the request is treated as binary mode. Structured Mode. In the Structured Content Mode, event metadata attributes and event data are placed into the HTTP request body. For structured mode, set the Content-Type header to application/cloudevents+json. Mandatory attributes of CloudEvents (specversion, id, type, and source) are required to be part of the request body. In addition, id data is provided as datacontenttype which is mandatory. We only support datacontenttype as \"application/json\". ### `ibmcloud event-notifications send-notifications` {: #event-notifications-cli-send-notifications-command} Send Notifications body from the instance. For more information about Event Notifications payload, see [here](https://cloud.ibm.com/docs/event-notifications?topic=event-notifications-en-spec-payload&format=markdown). ```sh ibmcloud event-notifications send-notifications --instance-id INSTANCE-ID [--body BODY] ``` #### Command options {: #event-notifications-send-notifications-cli-options} `--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]/`. `--body` ([`NotificationCreate`](#cli-notification-create-example-schema)) : 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`. ### NotificationCreate {: #cli-notification-create-example-schema} The following example shows the format of the NotificationCreate object. ```json { "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"}, "ibmenmarkdownn": "This is a *italic* message.\n- Item 1\n- Item 2\n**bold text** with more text data\n~~strike through~~\n1. order 1\n2. order 2\n```fenced code block```\n> block code\n`code`\n[Click here](https://example.com) for more info." "ibmenhtmlbody" : "exampleString", "subject" : "exampleString", "attachments": [ { "content": "VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQK", "filename": "test.txt", "content_type": "text/plain", "disposition": "attachment" } ], "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" : "{ }" } ``` {: codeblock} #### Example {: #event-notifications-send-notifications-examples} **With required parameters:** ```sh 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"}' ``` {: codeblock} **With all parameters:** ```sh 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": "{}"}' ``` {: codeblock} #### Additional properties that can be configured for the iOS notification {: #en-cli-send-notifications-command-addprops-ios} | Property | Property type | Description | |-------------|-------------|-------------| | `badge` | integer | The number to display as the badge of the application icon. | | `interactive_category` | string | The category identifier to be used for the interactive push notifications. | | `ios_action_key` | string |The title for the Action key. | | `payload` | JSON object | Custom JSON payload that is sent as part of the notification message. | | `sound` | string | The name of the sound file in the application bundle. The sound of this file is played as an alert. | | `title_loc_key` | string | The key to a title string in the Localizable.strings file for the current localization. The key string can be formatted with %@ and %n$@ specifiers to take the variables specified in the titleLocArgs array. | | `loc_key` | string | A key to an alert-message string in a Localizabl.strings file for the current localization (which is set by the user's language preference). The key string can be formatted with %@ and %n$@ specifiers to take the variables specified in the locArgs array. | | `launch_image` | string | The file name of an image file in the app bundle, with or without the file name extension. The image is used as the launch image when users tap the action button or move the action slider. | | `title_loc_args` | string | Variable string values to appear in place of the format specifiers in title-loc-key. | | `loc_args` | string | Variable string values to appear in place of the format specifiers in locKey. | title string The title of Rich Push notifications (Supported only on iOS 10 and above).| | `title` | string | The title of Rich Push notifications (Supported only on iOS 10 and above). | | `subtitle` | string | The subtitle of the Rich notifications (Supported only on iOS 10 and above). | | `body` | string | The body for IOS notifications. | | `attachment_url` | string | The link to the iOS notifications media (video, audio, GIF, images - Supported only on iOS 10 and above). | | `type` | string | Allowable values: DEFAULT, MIXED, SILENT. | | `apns_collapse_id` | string | Multiple notifications with the same collapse identifier are displayed to the user as a single notification. | | `apns_thread_id` | string | An app-specific identifier for grouping related notifications. This value corresponds to the threadIdentifier property in the UNNotificationContent object. | | `apns_group_summary_arg` | string | The string the notification adds to the category’s summary format string. | | `apns_group_summary_arg_count` | integer | The number of items the notification adds to the category’s summary format string. | {: caption="iOS platform settings" caption-side="bottom"} #### Additional properties that can be configured for the FCM notification {: #en-cli-send-notifications-command-addprops-fcm} | Property | Property type | Description | |-------------|-------------|-------------| | `icon` | string | Specify the name of the icon to be displayed for the notification. Make sure that the icon is already packaged with the client application. | | `delay_while_idle` | Boolean | When set to true, this parameter indicates that the message should not be sent until the device becomes active. | | `sync` | Boolean | Device group messaging makes it possible for every app instance in a group to reflect the latest messaging state. | | `visibility` | string | private or public - Visibility of this notification, which affects how and when the notifications are revealed on a secure locked screen. | | `redact` | string | Content that is specified shows up on a secure locked screen on the device when visibility is set to Private. | | `payload` | JSON object | Custom JSON payload that is sent as part of the notification message.| | `priority` | string | A string value that indicates the priority of this notification. Allowed values are 'max', 'high', 'default', 'low' and 'min'. High/Max priority notifications along with 'sound' field might be used for Heads up notification in Android 5.0 or higher.sampleval='low'. | | `sound` | string| The sound file (on device) that will be attempted to play when the notification arrives on the device. | | `time_to_live` | integer | Specifies how long (in seconds) the message should be kept in GCM storage if the device is offline. | `lights` | | Sets the notification LED color on receiving push notification. | | `ledArgb` | string | The color of the LED. The hardware does its best approximation. | | `ledOnMs` | integer | The time in milliseconds for the LED to be on while it's flashing. The hardware does its best approximation. | | `ledOffMs` | string | The time in milliseconds for the LED to be off while it's flashing. The hardware does its best approximation. | | `android_title` | string | The title of Rich Push notifications. | | `group_id` | string | Set this notification to be part of a group of notifications sharing the same key. Grouped notifications might display in a cluster or stack on devices that support such rendering. | | `style` | | Options to specify for Android expandable notifications. The types of expandable notifications are picture_notification, bigtext_notification, inbox_notification. | | `type` | string | Specifies the type of expandable notifications. The possible values are bigtext_notification, picture_notification, inbox_notification.| | `title` | string | Specifies the title of the notification. The title is displayed when the notification is expanded. Title must be specified for all three expandable notifications. | | `type` | string | Allowed values: DEFAULT, SILENT. | | `alert` | string | The alert value of Notification. | {: caption="Android platform settings" caption-side="bottom"} ## Sample script for Event Notifications provisioning using CLI {: #en-provisioning-script} The [provision_event_notification.sh](https://github.com/IBM/event-notifications/blob/main/samples/provision_event_notifications.sh){: external} script automates the provisioning and configuration of an Event Notifications instance. ## Sample script for platform notifications integration using CLI {: #en-platform-notifications-script} The [en-platform-notification-src-and-email-dest.sh](https://github.com/IBM/event-notifications/blob/main/samples/en-platform-notification-src-and-email-dest.sh){: external} script integrates Platform Notifications with Event Notifications and routes notifications to IBM Inbuilt Email or Custom Domain Sandbox. ## Sample script for IBM Cloud Logs integration using CLI {: #en-icl-script} The [en-icl-src-and-email-dest.sh](https://github.com/IBM/event-notifications/blob/main/samples/en-icl-src-and-email-dest.sh){: external} script integrates IBM Cloud Logs with Event Notifications and routes notifications to IBM Inbuilt Email or Custom Domain Sandbox . This script assumes that the IBM Cloud Logs instance and Event Notifications instance are in the same account. {: note} ## CLI version history {: #en-cli-version-history} Find a summary of changes for each version of Event Notifications plug-in. Keep your CLI up to date so that you can use all of the available commands and their options. {: shortdesc} The CLI Plugin versions from 0.0.5 to 1.9.0 is deprecated. {: note} | Version | Release date | Changes | |------------|--------------|---------| | 1.5.0 | 10 May 2024 | Support for SMTP Configuration and Slack Templates. | | 1.6.0 | 1 August 2024 | CF destination deprecated and MMS supported. | | 1.7.0 | 9 August 2024 | Support for metrics and removed support for SMTP allowed IPs from SMTP configuration.| | 1.8.0 | 9 September 2024 | Support for Slack DM destination. | | 1.9.0 | 11 October 2024 | Support for Webhook templates. | | 1.10.0 | 4 November 2024 | Removed support for Cloud Functions | | 1.11.0 | 7 January 2025 | Support for Periodic Timer | | 1.12.0 | 27 February 2025 | Support for Pagerduty template | | 1.13.0 | 6 March 2025 | Support for Event Streams destination, subscription and Templates. | | 1.14.0 | 28 April 2025 | PagerDuty destination deprecated parameter `api_key` is marked as optional. | | 1.15.0 | 27 June 2025 | The markdown content for notification. | | 1.16.0 | 1 Aug 2025 | Code Engine and Pre-defined Templates support. | | 1.17.0 | 4 September 2025 | Support webhook destination test get notifications-status command| | 1.18.0 | 25 Spetember 2025 | Appconfiguration destination, subscription and Template support | | 1.19.0 | 30 October 2025 | Support for clone smtp user credentials | | 1.20.0 | 15 December 2025 | Support for bounce metrics | | 1.20.1 | 19 January 2026 | Fix for private endpoint support metadata and EN plugin install issue in private.cloud.ibm.com | | 1.20.2 | 18 February 2026 | CLI plugin vulnerability fix patch update | | 1.21.0 | 7 April 2026 | CLI plugin update for view sandbox, email attachments and source options support for payload debugging | | 1.21.1 | 25 May 2026 | Deprecated init and show command and added en instances listing command. Fix provided to automatically set EN endpoint according to set target region. | | 1.21.2 | 29 June 2026 | Bug Fix for SMTP Metrics to support SMTP Config ID flag and mark destination type as optional. | | 1.21.3 | 6 August 2026 | CLI Plugin vulnerability fix, usability and cosmetic improvements | {: caption="Changes in the IBM Cloud Event Notifications CLI" caption-side="bottom"}