This email contains an attachment that will be uploaded to IBM Cloud Object Storage.
The downstream services will fetch it from COS.
", "ibmenmailto": "[\"kbbhatt04@gmail.com\"]", "ibmensourceid": "b291c708-8dea-463f-9448-70f8854c31db:api", "ibmensubject": "Test Email with COS Attachment", "id": "eeeea4ec-a536-4187-ab9c-5c63e4810e47", "source": "b291c708-8dea-463f-9448-70f8854c31db:api", "specversion": "1.0", "type": "test" } }, "GetNotificationStatusResponse": { "additionalProperties": false, "type": "object", "description": "Payload describing a notifications response", "properties": { "status": { "description": "status of the notification", "type": "string", "enum": [ "success", "failure", "inprogress" ] }, "details": { "$ref": "#/components/schemas/GetNotificationStatusResponseDetails" } }, "required": [ "status", "details" ], "example": { "status": "success", "details": { "status_code": 200, "status_message": "OK" } } }, "GetNotificationStatusResponseDetails": { "type": "object", "description": "Payload describing a Status Details", "additionalProperties": false, "properties": { "status_code": { "type": "integer", "description": "HTTP status code", "format": "int32" }, "status_message": { "description": "status message of the notification", "type": "string", "pattern": "[a-zA-Z]" } }, "required": [ "status_code", "status_message" ], "example": { "status_code": 200, "status_message": "OK" } }, "EnabledCountriesResponse": { "type": "object", "description": "Payload describing a custom SMS Configuration", "additionalProperties": false, "properties": { "status": { "description": "The SMS destination status", "minLength": 1, "type": "string", "pattern": "^(UNINITIALISED|INITIALISED|DISABLED)$" }, "enabled_countries": { "description": "List enabled countries", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/SMSCountryConfig" } } }, "required": [ "status", "enabled_countries" ], "example": { "status": "UNINITIALISED", "enabled_countries": [ { "country": [ "USA", "CH" ], "number": "60454" } ] } }, "DestinationCustomOptInResponse": { "type": "object", "description": "Custom Email Destination custom_opt_in response object", "additionalProperties": false, "properties": { "destination_type": { "description": "destination type", "type": "string", "minLength": 1, "pattern": ".*" }, "opt_in": { "description": "opt_in", "type": "boolean", "default": false }, "updated_at": { "description": "Updated at", "type": "string", "format": "date-time" } }, "required": [ "destination_type", "opt_in", "updated_at" ], "example": { "destination_type": "custom_email", "opt_in": true, "updated_at": "2023-09-08T13:25:20.523533Z" } }, "TestDestinationResponse": { "oneOf": [ { "$ref": "#/components/schemas/WebhookDestinationTestResponseConfig" }, { "$ref": "#/components/schemas/DestinationTestResponseConfig" } ] }, "WebhookDestinationTestResponseConfig": { "type": "object", "description": "Response from /test endpoint", "additionalProperties": false, "properties": { "status": { "type": "string", "description": "Test destination status", "minLength": 1, "maxLength": 8, "enum": [ "accepted" ] }, "notification_id": { "type": "string", "pattern": "[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": "Test notification ID" }, "destination_type": { "type": "string", "description": "Type of destination", "enum": [ "webhook" ] } }, "required": [ "status", "notification_id", "destination_type" ], "example": { "status": "accepted", "notification_id": "f8c6b0e0-7b18-4757-b1d3-7209779daf7d", "destination_type": "webhook" } }, "DestinationTestResponseConfig": { "type": "object", "description": "Test Destination response object for other http destination", "additionalProperties": false, "properties": { "status": { "type": "string", "description": "Test destination status", "minLength": 1, "maxLength": 7, "pattern": "^[A-Za-z .]+$" } }, "required": [ "status" ], "example": { "status": "success" } }, "TemplateResponse": { "additionalProperties": false, "type": "object", "description": "Payload describing a template get request", "properties": { "id": { "description": "Template ID", "type": "string", "pattern": "[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}", "minLength": 32, "maxLength": 100 }, "name": { "description": "Template name", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 255 }, "description": { "description": "Template description", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 255 }, "type": { "description": "The type of template", "minLength": 22, "maxLength": 24, "type": "string", "pattern": "^(smtp_custom.notification|smtp_custom.invitation|slack.notification|webhook.notification|pagerduty.notification|event_streams.notification|ibmcejob.notification|ibmceapp.notification|app_configuration.notification)$" }, "params": { "$ref": "#/components/schemas/TemplateConfigOneOf" }, "created_at": { "description": "Created time", "type": "string", "format": "date-time" } }, "required": [ "id", "name", "type", "params", "created_at" ], "example": { "params": { "body": "PGh0bWw+CiAgaGVsbG8gd29ybGQKPC9odG1sPg==", "subject": "This is the template subject" }, "created_at": "2021-10-07T07:05:52.098388257Z", "description": "Template description", "id": "fd72a88a-1111-0000-0000-e63141ce8b4a", "name": "template name", "type": "smtp_custom.notification" } }, "SMTPCreateResponse": { "additionalProperties": false, "type": "object", "description": "Payload describing a SMTP create response", "properties": { "id": { "description": "SMTP ID", "type": "string", "pattern": "[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}", "minLength": 32, "maxLength": 100 }, "name": { "description": "SMTP name", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 250 }, "description": { "description": "SMTP description", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 250 }, "domain": { "description": "Domain Name", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 512 }, "config": { "$ref": "#/components/schemas/SMTPConfig" }, "created_at": { "description": "Created time", "type": "string", "format": "date-time" } }, "required": [ "id", "name", "domain", "config", "created_at" ], "example": { "id": "cb8421b2-63c9-43cb-ae6f-16ae53285ba1", "name": "SMTP name", "description": "SMTP description", "domain": "cloudflare-ipfs.com", "config": { "dkim": { "txt_name": "35ef4bc3-a7a6-48e9-882a-6fd70c162ec2._domainkey.abc.event-notifications.test.cloud.ibm.com", "txt_value": "v=DKIM1; h=sha256; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuzCOM3TfCHGzZ6myd5DIQPjahLjkbK15aiq7ElDhqHQwNq/5EnPutNptFg7LurV2o9Tl9GSrPFC9GGJn8+5wtJRoeHfSm//dPXB9dpQb4rRjono8obaAbc2A6tVBXdFf814tw04ZDw6JzCmn3RvVmAy5+mwQ+SL6oqbU62CMv6eLtF26MEagbUZKmp5mpru0natkV/mwPk/vudJ8eVoOyjTfwRws9dLc3JaTdT77wSkyKqW64nYePO4j8kVHXj2bQTm4M+GJL2bzc8RwPKPvdy/FiK4Op2qzbzHNGL/V9Fj9xhYE4p1sopLJtZaTvkbZqbvB1KZJ1YqByHl4zcL/uQIDAQAB", "verification": "PENDING" }, "en_authorization": { "verification": "PENDING" }, "spf": { "txt_name": "cloudflare-ipfs.com", "txt_value": "v=spf1 include:mail.event-notifications.test.cloud.ibm.com -all", "verification": "SUCCESSFUL" } }, "created_at": "2024-04-16T13:16:56.079093Z" } }, "SMTPConfiguration": { "additionalProperties": false, "type": "object", "description": "Payload describing a SMTP List response", "properties": { "id": { "description": "SMTP ID", "type": "string", "pattern": "[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}", "minLength": 32, "maxLength": 100 }, "name": { "description": "SMTP name", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 250 }, "description": { "description": "SMTP description", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 250 }, "domain": { "description": "Domain Name", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 512 }, "config": { "$ref": "#/components/schemas/SMTPConfig" }, "updated_at": { "description": "Created time", "type": "string", "format": "date-time" } }, "required": [ "id", "name", "domain", "config", "updated_at" ], "example": { "config": { "dkim": { "txt_name": "35ef4bc3-a7a6-48e9-882a-6fd70c162ec2._domainkey.abc.event-notifications.test.cloud.ibm.com", "txt_value": "v=DKIM1; h=sha256; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuzCOM3TfCHGzZ6myd5DIQPjahLjkbK15aiq7ElDhqHQwNq/5EnPutNptFg7LurV2o9Tl9GSrPFC9GGJn8+5wtJRoeHfSm//dPXB9dpQb4rRjono8obaAbc2A6tVBXdFf814tw04ZDw6JzCmn3RvVmAy5+mwQ+SL6oqbU62CMv6eLtF26MEagbUZKmp5mpru0natkV/mwPk/vudJ8eVoOyjTfwRws9dLc3JaTdT77wSkyKqW64nYePO4j8kVHXj2bQTm4M+GJL2bzc8RwPKPvdy/FiK4Op2qzbzHNGL/V9Fj9xhYE4p1sopLJtZaTvkbZqbvB1KZJ1YqByHl4zcL/uQIDAQAB", "verification": "PENDING" }, "en_authorization": { "verification": "SUCCESSFUL" }, "spf": { "txt_name": "maily.event-notifications.test.cloud.ibm.com", "txt_value": "v=spf1 include:mail.event-notifications.test.cloud.ibm.com -all", "verification": "PENDING" } }, "description": "utilize distributed deliverables", "domain": "maily.event-notifications.test.cloud.ibm.com", "id": "79ca7029-1a68-43d6-8e64-8cd8d1d84aed", "name": "revolutionize synergistic e-commerce", "updated_at": "2024-04-17T09:34:18.274413Z" } }, "SMTPUserResponse": { "additionalProperties": false, "type": "object", "description": "Payload describing a SMTP User create response", "properties": { "id": { "description": "SMTP Id", "type": "string", "pattern": "[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}", "minLength": 32, "maxLength": 100 }, "description": { "description": "SMTP User description", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 250 }, "domain": { "description": "Domain Name", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 512 }, "smtp_config_id": { "description": "SMTP confg Id", "type": "string", "pattern": "[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}", "minLength": 32, "maxLength": 100 }, "username": { "description": "SMTP user name", "type": "string", "minLength": 3, "pattern": ".*", "maxLength": 250 }, "password": { "description": "Password for SMTP user; Cloned SMTP user response do not include a password", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 250 }, "created_at": { "description": "Created time", "type": "string", "format": "date-time" } }, "required": [ "id", "username", "created_at", "smtp_config_id" ], "example": { "id": "cb8421b2-63c9-43cb-ae6f-16ae53285ba1", "description": "SMTP user description", "username": "MTIzZTQ1Njc7NTA5NTU2LTMtMTJkMy1hNDU2LTQyNjYxNDE3NDAwMHVzLXNvdXRo", "password": "password", "domain": "test.event-notifications.test.cloud.ibm.com", "smtp_config_id": "accec70c-752d-4920-bf86-146b2eade10f", "created_at": "2024-04-16T13:16:56.079093Z" } }, "DestinationResponse": { "additionalProperties": false, "type": "object", "description": "Payload describing a destination get request", "properties": { "id": { "description": "Destination ID", "type": "string", "pattern": "[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}", "minLength": 36, "maxLength": 100 }, "name": { "description": "Destination name", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 255 }, "description": { "description": "Destination description", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 255 }, "type": { "description": "Destination type", "type": "string", "minLength": 1, "maxLength": 50, "enum": [ "webhook", "push_android", "push_ios", "push_chrome", "push_firefox", "slack", "ibmce", "pagerduty", "push_safari", "msteams", "servicenow", "ibmcos", "push_huawei", "smtp_custom", "smtp_custom_sandbox", "sms_custom", "event_streams", "app_configuration" ] }, "collect_failed_events": { "description": "Whether to collect the failed event in Cloud Object Storage bucket", "type": "boolean", "default": false }, "config": { "$ref": "#/components/schemas/DestinationConfig" }, "created_at": { "description": "Last updated time", "type": "string", "format": "date-time" } }, "required": [ "id", "name", "description", "type", "config", "created_at" ], "example": { "config": { "params": { "custom_headers": { "authorization": "2c9a0cfb-bfd7-xx43a-9274-94cjk8a9b0ce2f" }, "sensitive_headers": [ "authorization" ], "url": "https://cloud.ibm.com/nhwebhook/sendwebhook", "verb": "post" } }, "created_at": "2021-10-07T07:05:52.098388257Z", "description": "This destination is for webhook test purpose in e2e", "id": "fd72a88a-bc88-491d-bb75-e63141ce8b4a", "name": "Admin Webhook Compliance", "type": "webhook" } }, "DestinationPublicKey": { "additionalProperties": false, "type": "object", "description": "Payload describing public key", "properties": { "public_key": { "description": "The Public Key must be used to decrypt and verify the Webhook payload received. PEM is in the form of Base64 encoded DER certificate. The response string contains one or more items in Base64 ASCII encoding, each with plain-text headers and footers", "type": "string", "minLength": 1, "pattern": "[a-zA-Z0-9-:_].*" } }, "required": [ "public_key" ], "example": { "public_key": "-----BEGIN PUBLIC KEY-----\nMIIag\np6PZt8DsRmJD2zR4+rfCUdUPYPN5dMOCA8Vm/48qj1GASNB6AXeHdZ3GDe/MYCT0\njVZOfnxxx3EMm8BsVHwrGkYPDs\nYtieyQdPt47+wDPlc2mY4/vxxxxxlgPS+rpUKaN0zxW3cP5xx\n2wIxxQAB\n-----END PUBLIC KEY-----\n" } }, "TemplateUpdate": { "type": "object", "description": "Payload describing a template update request", "additionalProperties": false, "properties": { "name": { "description": "Template name", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 255 }, "description": { "description": "Template description", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 255 }, "type": { "description": "The type of template", "minLength": 22, "maxLength": 24, "type": "string", "pattern": "^(smtp_custom.notification|smtp_custom.invitation|slack.notification|webhook.notification|pagerduty.notification|event_streams.notification|ibmcejob.notification|ibmceapp.notification|app_configuration.notification)$" }, "params": { "$ref": "#/components/schemas/TemplateConfigOneOf" } }, "example": { "name": "Message Template update", "type": "smtp_custom.invitation", "description": "Template description", "params": { "body": "PGh0bWw+CiAgaGVsbG8gd29ybGQKPC9odG1sPg==", "subject": "HI This is the template subject for the invitation" } } }, "SMTPUpdate": { "type": "object", "description": "Payload describing a SMTP update request", "additionalProperties": false, "properties": { "name": { "description": "SMTP name", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 250 }, "description": { "description": "SMTP description", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 250 } }, "example": { "name": "SMTP name", "description": "SMTP description" } }, "SMTPUserUpdate": { "type": "object", "description": "Payload describing a SMTP user update request", "additionalProperties": false, "properties": { "description": { "description": "SMTP user description", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 250 } }, "example": { "description": "SMTP user description" } }, "DestinationUpdate": { "type": "object", "description": "Payload describing a destination update request", "additionalProperties": false, "properties": { "name": { "description": "Destination name", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 255 }, "description": { "description": "Destination description", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 255 }, "collect_failed_events": { "description": "Whether to collect the failed event in Cloud Object Storage bucket", "type": "boolean", "default": false }, "config": { "$ref": "#/components/schemas/DestinationConfig" }, "certificate": { "description": "Certificate for APNS", "type": "string", "format": "binary", "minLength": 1, "maxLength": 5000 }, "icon_16x16": { "description": "Safari icon 16x16", "type": "string", "format": "binary", "minLength": 1, "maxLength": 5000 }, "icon_16x16_2x": { "description": "Safari icon 16x16@2x", "type": "string", "format": "binary", "minLength": 1, "maxLength": 5000 }, "icon_32x32": { "description": "Safari icon 32x32", "type": "string", "format": "binary", "minLength": 1, "maxLength": 5000 }, "icon_32x32_2x": { "description": "Safari icon 32x32@2x", "type": "string", "format": "binary", "minLength": 1, "maxLength": 5000 }, "icon_128x128": { "description": "Safari icon 128x128", "type": "string", "format": "binary", "minLength": 1, "maxLength": 5000 }, "icon_128x128_2x": { "description": "Safari icon 128x128@2x", "type": "string", "format": "binary", "minLength": 1, "maxLength": 5000 } }, "example": { "name": "Webhook Slack function", "description": "This webhook triggers a function which sends message to Slack", "config": { "params": { "url": "https://1ea472c0.us-south.apigw.appdomain.cloud/nhwebhook/sendwebhook", "verb": "post", "custom_headers": { "authorization": "tty-xxx-657-rtue" }, "sensitive_headers": [ "authorization" ] } } } }, "TagsSubscriptionList": { "type": "object", "description": "Payload describing a tags list request", "additionalProperties": false, "properties": { "total_count": { "type": "integer", "description": "Total number of tags", "format": "int32" }, "offset": { "type": "integer", "description": "Current offset", "format": "int32" }, "limit": { "type": "integer", "description": "limit to show tags", "format": "int32" }, "tag_subscriptions": { "type": "array", "description": "List of tags", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/TagsSubscriptionListItem" } }, "first": { "$ref": "#/components/schemas/PageHrefResponse" }, "previous": { "$ref": "#/components/schemas/PageHrefResponse" }, "next": { "$ref": "#/components/schemas/PageHrefResponse" } }, "required": [ "limit", "offset", "total_count", "tag_subscriptions" ], "example": { "tag_subscriptions": [ { "id": "330cfdf8-7ae6-4afb-aac1-458243877d00", "device_id": "11fe18ba-d0c8-4108-9f07-355e8052a813", "tag_name": "sl_web", "user_id": "fcm_id_123", "updated_at": "2021-09-05T00:25:19.599884Z" }, { "id": "9a7aa117-58ee-48ea-8b08-3ad4be22647c", "device_id": "11fe18ba-d0c8-4108-9f07-355e8052a813", "tag_name": "SMTP_apireview", "user_id": "fcm_id_123", "updated_at": "2021-09-17T01:06:04.565646Z" }, { "id": "cb82dc07-105c-441c-9fa0-ba22f6525318", "device_id": "11fe18ba-d0c8-4108-9f07-355e8052a813", "tag_name": "SMS_destination", "user_id": "fcm_id_123", "updated_at": "2021-09-17T01:03:55.313179Z" } ], "first": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/destinations/axxxxx-xxxxx-xxxxx-rtc4-xxxxx/tag_subscriptions?limit=10&offset=0" }, "next": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/destinations/axxxxx-xxxxx-xxxxx-rtc4-xxxxx/tag_subscriptions?limit=10&offset=10" }, "limit": 10, "offset": 0, "total_count": 3 } }, "TagsSubscriptionListItem": { "type": "object", "description": "Tags subscription object", "additionalProperties": false, "properties": { "id": { "description": "Subscription Tag ID", "type": "string", "pattern": "[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}", "minLength": 36, "maxLength": 150 }, "device_id": { "description": "Unique identifier of the device", "type": "string", "pattern": "[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}", "minLength": 1, "maxLength": 150 }, "tag_name": { "description": "The name of the tag its subscribed", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 255 }, "user_id": { "description": "The user identifier for the device registration", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 255 }, "updated_at": { "description": "Updated at", "type": "string", "format": "date-time" } }, "required": [ "id", "device_id", "tag_name", "updated_at" ], "example": { "id": "cb82dc07-105c-441c-9fa0-ba22f6525318", "device_id": "11fe18ba-d0c8-4108-9f07-355e8052a813", "tag_name": "sl_web", "user_id": "deveoper_fcm", "updated_at": "2021-09-05T00:25:19.599884Z" } }, "TemplateList": { "type": "object", "description": "Payload describing a template list request", "additionalProperties": false, "properties": { "total_count": { "type": "integer", "description": "Total number of templates", "format": "int32" }, "offset": { "type": "integer", "description": "Current offset", "format": "int32" }, "limit": { "type": "integer", "description": "limit to show templates", "format": "int32" }, "templates": { "type": "array", "description": "List of templates", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/Template" } }, "first": { "$ref": "#/components/schemas/PageHrefResponse" }, "previous": { "$ref": "#/components/schemas/PageHrefResponse" }, "next": { "$ref": "#/components/schemas/PageHrefResponse" } }, "required": [ "limit", "offset", "total_count", "templates" ], "example": { "templates": [ { "id": "11fe18ba-0000-0000-9f07-355e8052a813", "name": "template name", "description": "Template description", "type": "smtp_custom.notification", "subscription_count": 2, "subscription_names": [ "abc", "xyz" ], "updated_at": "2021-09-05T00:25:19.599884Z" }, { "id": "1e99ad0e-0000-4d02-0000-e45c974bb422", "name": "template name", "description": "template description", "type": "smtp_custom.invitation", "subscription_count": 1, "subscription_names": [ "abc" ], "updated_at": "2021-09-17T01:06:04.565646Z" } ], "first": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/templates?limit=10&offset=0" }, "next": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/templates?limit=10&offset=10" }, "limit": 10, "offset": 0, "total_count": 9 } }, "PredefinedTemplatesList": { "type": "object", "description": "Payload describing a pre-defined templates list request", "additionalProperties": false, "properties": { "total_count": { "type": "integer", "description": "Total number of pre-defined templates", "format": "int32" }, "offset": { "type": "integer", "description": "Current offset", "format": "int32" }, "limit": { "type": "integer", "description": "limit to show templates", "format": "int32" }, "templates": { "type": "array", "description": "List of pre-defined templates", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/PredefinedTemplate" } }, "first": { "$ref": "#/components/schemas/PageHrefResponse" }, "previous": { "$ref": "#/components/schemas/PageHrefResponse" }, "next": { "$ref": "#/components/schemas/PageHrefResponse" } }, "required": [ "limit", "offset", "total_count", "templates" ], "example": { "templates": [ { "description": "pre-defined template for slack from toolchain", "id": "35b9614f-2bc0-440c-a94f-15857aeb23e8", "name": "predefined template1", "type": "slack", "source": "toolchain", "updated_at": "2025-12-12T16:48:40.664954Z" }, { "description": "pre-defined template for cloud object storage from cloud logs", "id": "0b8cb16d-16b9-4ef3-ad8b-ccecc21a659f", "name": "predefined template2", "type": "cos", "source": "logs", "updated_at": "2025-12-12T16:48:40.664954Z" } ], "limit": 10, "offset": 0, "total_count": 2 } }, "BounceMetricItem": { "type": "object", "description": "Bounce metric object", "additionalProperties": false, "properties": { "email_address": { "description": "Email address", "type": "string", "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$", "minLength": 1, "maxLength": 255 }, "subject": { "description": "Subject", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 255 }, "error_message": { "description": "Error message", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 255 }, "ip_address": { "description": "IP address", "type": "string", "pattern": "^\\d{1,3}(\\.\\d{1,3}){3}$", "minLength": 0, "maxLength": 255 }, "subscription_id": { "description": "Subscription ID", "type": "string", "pattern": "[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}", "minLength": 1, "maxLength": 150 }, "timestamp": { "description": "Bounced at", "type": "string", "format": "date-time" } }, "required": [ "email_address", "subject", "error_message", "timestamp" ], "example": { "timestamp": "2025-12-03T07:37:33Z", "subscription_id": "0bc82d4e-6e81-415d-9fe3-b530a73fabe9", "email_address": "email@domain.com", "subject": "This is a test subject", "error_message": "UNKNOWN_USER", "ip_address": "199.46.34.10" } }, "Metric": { "type": "object", "description": "Payload describing metrics request", "additionalProperties": false, "properties": { "key": { "description": "key", "type": "string", "enum": [ "bounced", "deferred", "opened", "success", "submitted" ], "minLength": 1, "maxLength": 255 }, "doc_count": { "type": "integer", "description": "doc count", "format": "int32" }, "histogram": { "$ref": "#/components/schemas/Histrogram" } } }, "Histrogram": { "type": "object", "description": "Payload describing histogram", "additionalProperties": false, "properties": { "buckets": { "description": "List of buckets", "type": "array", "minItems": 0, "maxItems": 48, "items": { "$ref": "#/components/schemas/Buckets" } } } }, "DestinationList": { "type": "object", "description": "Payload describing a destination list request", "additionalProperties": false, "properties": { "total_count": { "type": "integer", "description": "Total number of destinations", "format": "int32" }, "offset": { "type": "integer", "description": "Current offset", "format": "int32" }, "limit": { "type": "integer", "description": "limit to show destinations", "format": "int32" }, "destinations": { "type": "array", "description": "List of destinations", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/DestinationListItem" } }, "first": { "$ref": "#/components/schemas/PageHrefResponse" }, "previous": { "$ref": "#/components/schemas/PageHrefResponse" }, "next": { "$ref": "#/components/schemas/PageHrefResponse" } }, "required": [ "limit", "offset", "total_count", "destinations" ], "example": { "destinations": [ { "id": "11fe18ba-d0c8-4108-9f07-355e8052a813", "name": "SL Web", "description": "This destination is for webhook purpose new", "type": "webhook", "subscription_count": 2, "subscription_names": [ "Webhook Sub for new change" ], "updated_at": "2021-09-05T00:25:19.599884Z" }, { "id": "1e99ad0e-f1ec-4d02-9162-e45c974bb422", "name": "SMTP apireview updated", "description": "wow this is amazing", "type": "smtp_ibm", "subscription_count": 1, "subscription_names": [ "smtp apireview sub" ], "updated_at": "2021-09-17T01:06:04.565646Z" }, { "id": "47d31664-0943-41a4-a174-9fdf60716e8d", "name": "SMS destination apireview", "description": "This destination is for sms test purpose", "type": "sms_ibm", "subscription_count": 1, "subscription_names": [ "sms sub apireview" ], "updated_at": "2021-09-17T01:03:55.313179Z" }, { "id": "81ed6419-e7fd-44c6-9d7e-79df74f282d6", "name": "webhook destination encrypt again2", "description": "This destination is for webhook test purpose", "type": "webhook", "subscription_count": 2, "subscription_names": [ "Webhook sub", "Webhook new payload test" ], "updated_at": "2021-08-23T06:29:49.020232Z" }, { "id": "b5cb3f03-ff12-42f3-9fae-37ee27f2a81a", "name": "email destination", "description": "This destination is for email purpose", "type": "smtp_ibm", "subscription_count": 2, "subscription_names": [ "Test subscription", "Email Subscription on new change" ], "updated_at": "2021-08-17T11:20:01.296323Z" }, { "id": "be9709a4-aa74-4e41-89ef-762c3780ef26", "name": "Webhook Dest apireview", "description": "This destination is for webhook test purpose", "type": "webhook", "subscription_count": 1, "subscription_names": [ "webhook sub apireview" ], "updated_at": "2021-09-17T00:49:03.659326Z" }, { "id": "d4ff1d27-4c0d-4e32-9706-567015d7e531", "name": "webhook revamped", "description": "", "type": "webhook", "subscription_count": 0, "subscription_names": [], "updated_at": "2021-09-17T01:52:41.568987Z" }, { "id": "ec28efee-2236-4c2d-8839-d34f697cfc69", "name": "sms destination", "description": "This destination is for sms purpose", "type": "sms_ibm", "subscription_count": 1, "subscription_names": [ "SMS Subscription on new change" ], "updated_at": "2021-08-17T11:19:56.293221Z" }, { "id": "eda2e472-86ae-494f-83c0-4990ba79790d", "name": "SMS destination 5", "description": "This destination is for sms test purpose", "type": "sms_ibm", "subscription_count": 0, "subscription_names": [], "updated_at": "2021-09-08T13:13:55.183553Z" } ], "first": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/destinations?limit=10&offset=0" }, "next": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/destinations?limit=10&offset=10" }, "limit": 10, "offset": 0, "total_count": 9 } }, "SMTPUsersList": { "type": "object", "description": "Payload describing a SMTP users list request", "additionalProperties": false, "properties": { "total_count": { "type": "integer", "description": "Total number of destinations", "format": "int32" }, "offset": { "type": "integer", "description": "Current offset", "format": "int32" }, "limit": { "type": "integer", "description": "limit to show destinations", "format": "int32" }, "users": { "type": "array", "description": "List of users", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/SMTPUser" } }, "first": { "$ref": "#/components/schemas/PageHrefResponse" }, "previous": { "$ref": "#/components/schemas/PageHrefResponse" }, "next": { "$ref": "#/components/schemas/PageHrefResponse" } }, "required": [ "limit", "offset", "total_count", "users" ], "example": { "users": [ { "created_at": "2024-04-16T17:36:24.562614Z", "description": "disintermediate turn-key lifetime value", "domain": "ashwin.event-notifications.test.cloud.ibm.com", "id": "68e541cb-72b1-4eb6-ae51-766b3eaf8fd9", "smtp_config_id": "accec70c-752d-4920-bf86-146b2eade10f", "updated_at": "2024-04-16T17:36:24.562614Z", "username": "39083891827184zey101" }, { "created_at": "2024-04-16T17:36:24.562614Z", "description": "optimize interactive experiences", "domain": "ashwin.event-notifications.test.cloud.ibm.com", "id": "3abf9635-42e0-4c76-9d38-97f043288f4e", "smtp_config_id": "accec70c-752d-4920-bf86-146b2eade10f", "updated_at": "2024-04-16T19:40:08.925973Z", "username": "1496562uy307fuk01201" }, { "created_at": "2024-04-16T17:36:24.562614Z", "description": "innovate cross-platform systems", "domain": "ashwin.event-notifications.test.cloud.ibm.com", "smtp_config_id": "accec70c-752d-4920-bf86-146b2eade10f", "id": "446f2f29-c38f-43e3-9783-2874e9de43e7", "updated_at": "2024-04-17T12:25:31.881298Z", "username": "7387a14m5qk133616301" } ], "first": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/destinations?limit=10&offset=0" }, "next": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/destinations?limit=10&offset=10" }, "limit": 10, "offset": 0, "total_count": 3 } }, "SMTPConfigurationsList": { "type": "object", "description": "Payload describing a SMTP Configurations list", "additionalProperties": false, "properties": { "total_count": { "type": "integer", "description": "Total number of SMTP configurations", "format": "int32" }, "offset": { "type": "integer", "description": "Current offset", "format": "int32" }, "limit": { "type": "integer", "description": "limit to show configurations", "format": "int32" }, "smtp_configurations": { "type": "array", "description": "List of SMTP Configurations", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/SMTPConfiguration" } }, "first": { "$ref": "#/components/schemas/PageHrefResponse" }, "previous": { "$ref": "#/components/schemas/PageHrefResponse" }, "next": { "$ref": "#/components/schemas/PageHrefResponse" } }, "required": [ "limit", "offset", "total_count", "smtp_configurations" ], "example": { "limit": 10, "offset": 0, "smtp_configurations": [ { "config": { "dkim": { "txt_name": "35ef4bc3-a7a6-48e9-882a-6fd70c162ec2._domainkey.abc.event-notifications.test.cloud.ibm.com", "txt_value": "v=DKIM1; h=sha256; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuzCOM3TfCHGzZ6myd5DIQPjahLjkbK15aiq7ElDhqHQwNq/5EnPutNptFg7LurV2o9Tl9GSrPFC9GGJn8+5wtJRoeHfSm//dPXB9dpQb4rRjono8obaAbc2A6tVBXdFf814tw04ZDw6JzCmn3RvVmAy5+mwQ+SL6oqbU62CMv6eLtF26MEagbUZKmp5mpru0natkV/mwPk/vudJ8eVoOyjTfwRws9dLc3JaTdT77wSkyKqW64nYePO4j8kVHXj2bQTm4M+GJL2bzc8RwPKPvdy/FiK4Op2qzbzHNGL/V9Fj9xhYE4p1sopLJtZaTvkbZqbvB1KZJ1YqByHl4zcL/uQIDAQAB", "verification": "PENDING" }, "en_authorization": { "verification": "SUCCESSFUL" }, "spf": { "txt_name": "test.event-notifications.test.cloud.ibm.com", "txt_value": "v=spf1 include:mail.event-notifications.test.cloud.ibm.com -all", "verification": "SUCCESSFUL" } }, "description": "disintermediate clicks-and-mortar channels", "domain": "test.event-notifications.test.cloud.ibm.com", "id": "accec70c-752d-4920-bf86-146b2eade10f", "name": "revolutionize front-end markets", "updated_at": "2024-04-16T20:04:40.055197Z" }, { "config": { "dkim": { "txt_name": "35ef4bc3-a7a6-48e9-882a-6fd70c162ec2._domainkey.abc.event-notifications.test.cloud.ibm.com", "txt_value": "v=DKIM1; h=sha256; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAuzCOM3TfCHGzZ6myd5DIQPjahLjkbK15aiq7ElDhqHQwNq/5EnPutNptFg7LurV2o9Tl9GSrPFC9GGJn8+5wtJRoeHfSm//dPXB9dpQb4rRjono8obaAbc2A6tVBXdFf814tw04ZDw6JzCmn3RvVmAy5+mwQ+SL6oqbU62CMv6eLtF26MEagbUZKmp5mpru0natkV/mwPk/vudJ8eVoOyjTfwRws9dLc3JaTdT77wSkyKqW64nYePO4j8kVHXj2bQTm4M+GJL2bzc8RwPKPvdy/FiK4Op2qzbzHNGL/V9Fj9xhYE4p1sopLJtZaTvkbZqbvB1KZJ1YqByHl4zcL/XXXXXXXX", "verification": "PENDING" }, "en_authorization": { "verification": "SUCCESSFUL" }, "spf": { "txt_name": "maily.event-notifications.test.cloud.ibm.com", "txt_value": "v=spf1 include:mail.event-notifications.test.cloud.ibm.com -all", "verification": "PENDING" } }, "description": "utilize distributed deliverables", "domain": "maily.event-notifications.test.cloud.ibm.com", "id": "79ca7029-1a68-43d6-8e64-8cd8d1d84aed", "name": "revolutionize synergistic e-commerce", "updated_at": "2024-04-17T09:34:18.274413Z" } ], "total_count": 2 } }, "Template": { "type": "object", "description": "Template object", "additionalProperties": false, "properties": { "id": { "description": "Template ID", "type": "string", "pattern": "[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}", "minLength": 32, "maxLength": 150 }, "name": { "description": "Template name", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 255 }, "description": { "description": "Template description", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 0, "maxLength": 255 }, "type": { "description": "The type of template", "minLength": 22, "maxLength": 24, "type": "string", "pattern": "^(smtp_custom.notification|smtp_custom.invitation|slack.notification|webhook.notification|pagerduty.notification|event_streams.notification|ibmcejob.notification|ibmceapp.notification|app_configuration.notification)$" }, "subscription_count": { "description": "Subscription count", "type": "integer", "format": "int32" }, "subscription_names": { "type": "array", "minItems": 0, "maxItems": 100, "description": "Names of subscriptions", "items": { "type": "string", "pattern": "[a-zA-Z0-9-:_].*", "minLength": 1 } }, "updated_at": { "description": "Updated at", "type": "string", "format": "date-time" } }, "required": [ "id", "name", "description", "type", "subscription_count", "subscription_names", "updated_at" ], "example": { "id": "fd72a81a-1111-0000-0000-e63141ce8b4a", "name": "template name", "description": "This is for template description", "type": "smtp_custom.notification", "subscription_count": 2, "subscription_names": [ "xyz", "abc" ], "updated_at": "2021-09-05T00:25:19.599884Z" } }, "GetPredefinedTemplate": { "type": "object", "description": "Template object", "additionalProperties": false, "properties": { "id": { "description": "Template ID", "type": "string", "pattern": "[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}", "minLength": 32, "maxLength": 150 }, "name": { "description": "Template name", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 255 }, "description": { "description": "Template description", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 0, "maxLength": 255 }, "type": { "description": "The type of template", "minLength": 1, "maxLength": 24, "type": "string", "pattern": ".*" }, "source": { "description": "The type of source", "minLength": 1, "type": "string", "pattern": ".*" }, "updated_at": { "description": "Updated at", "type": "string", "format": "date-time" }, "params": { "$ref": "#/components/schemas/PredefinedTemplateConfig" } }, "required": [ "id", "name", "description", "type", "updated_at", "params" ], "example": { "id": "fd72a81a-1111-0000-0000-e63141ce8b4a", "name": "predefined template", "description": "This is for template description", "type": "slack", "source": "toolchain", "updated_at": "2025-12-12T16:48:40.664954Z", "params": { "body": "OndoaXRlX2NoZWNrX21hcms6ICpkZXRlY3Qtc2VjcmV0cyogc3VjY2Vzc2Z1bCBpbiB0YXNrIF9jb2RlLWRldGVjdC1zZWNyZXRzXw==" } } }, "PredefinedTemplate": { "type": "object", "description": "Predefined Template object", "additionalProperties": false, "properties": { "id": { "description": "Template ID", "type": "string", "pattern": "[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}", "minLength": 32, "maxLength": 150 }, "name": { "description": "Template name", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 255 }, "description": { "description": "Template description", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 0, "maxLength": 255 }, "source": { "description": "The type of source", "minLength": 1, "type": "string", "pattern": ".*" }, "type": { "description": "The type of template", "minLength": 1, "type": "string", "pattern": ".*" }, "updated_at": { "description": "Updated at", "type": "string", "format": "date-time" } }, "required": [ "id", "name", "description", "type", "source", "updated_at" ], "example": { "id": "fd72a81a-1111-0000-0000-e63141ce8b4a", "name": "template name", "source": "toolchain", "description": "This is for template description", "type": "smtp_custom.notification", "updated_at": "2021-09-05T00:25:19.599884Z" } }, "SMTPUser": { "additionalProperties": false, "type": "object", "description": "Payload describing a SMTP User", "properties": { "id": { "description": "Id", "type": "string", "pattern": "[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}", "minLength": 32, "maxLength": 100 }, "smtp_config_id": { "description": "SMTP confg Id", "type": "string", "pattern": "[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}", "minLength": 32, "maxLength": 100 }, "description": { "description": "SMTP User description", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 250 }, "domain": { "description": "Domain Name", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 512 }, "username": { "description": "SMTP user name", "type": "string", "minLength": 3, "pattern": ".*", "maxLength": 250 }, "created_at": { "description": "Updated time", "type": "string", "format": "date-time" }, "updated_at": { "description": "Updated time", "type": "string", "format": "date-time" } }, "required": [ "id", "smtp_config_id", "description", "domain", "username", "created_at", "updated_at" ], "example": { "id": "cb8421b2-63c9-43cb-ae6f-16ae53285ba1", "smtp_config_id": "accec70c-752d-4920-bf86-146b2eade10f", "description": "SMTP user description", "domain": "test.event-notifications.test.cloud.ibm.com", "username": "MTIzZTQ1Njc7NTA5NTU2LTMtMTJkMy1hNDU2LTQyNjYxNDE3NDAwMHVzLXNvdXRo", "created_at": "2024-04-16T17:36:24.562614Z", "updated_at": "2024-04-16T13:16:56.079093Z" } }, "Metrics": { "type": "object", "description": "Payload describing a metrics", "additionalProperties": false, "properties": { "metrics": { "description": "array of metrics", "type": "array", "minItems": 5, "maxItems": 5, "items": { "$ref": "#/components/schemas/Metric" } } }, "required": [ "metrics" ], "example": { "metrics": [ { "key": "bounced", "doc_count": 1, "histogram": { "buckets": [ { "doc_count": 1, "key_as_string": "2024-06-16T09:00:00Z" } ] } }, { "key": "deferred", "doc_count": 1, "histogram": { "buckets": [ { "doc_count": 1, "key_as_string": "2024-06-16T09:00:00Z" } ] } }, { "key": "opened", "doc_count": 1, "histogram": { "buckets": [ { "doc_count": 1, "key_as_string": "2024-06-16T09:00:00Z" } ] } }, { "key": "success", "doc_count": 1, "histogram": { "buckets": [ { "doc_count": 1, "key_as_string": "2024-06-16T09:00:00Z" } ] } }, { "key": "submitted", "doc_count": 1, "histogram": { "buckets": [ { "doc_count": 1, "key_as_string": "2024-06-16T09:00:00Z" } ] } } ] } }, "BounceMetrics": { "type": "object", "description": "Payload describing bounce metrics", "additionalProperties": false, "properties": { "metrics": { "description": "array of bounce metrics", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/BounceMetricItem" } }, "total_count": { "description": "total number of bounce metrics", "type": "integer", "minimum": 0, "format": "int32" }, "offset": { "type": "integer", "description": "Current offset", "format": "int32" }, "limit": { "type": "integer", "description": "limit to show bounce metrics", "format": "int32" } }, "required": [ "metrics", "total_count", "limit", "offset" ], "example": { "metrics": [ { "timestamp": "2025-12-03T07:37:33Z", "subscription_id": "0bc82d4e-6e81-415d-9fe3-b530a73fabe9", "email_address": "email@domain.com", "subject": "This is a test subject", "error_message": "UNKNOWN_USER", "ip_address": "199.46.34.10" } ], "limit": 10, "offset": 0, "total_count": 1 } }, "SMTPAllowedIPs": { "type": "object", "description": "Payload describing a SMTP allowed Ips", "additionalProperties": false, "properties": { "subnets": { "type": "array", "description": "The SMTP allowed Ips", "minItems": 1, "maxItems": 100, "items": { "type": "string", "minLength": 1, "maxLength": 20, "pattern": ".*" } }, "updated_at": { "description": "Updated at", "type": "string", "format": "date-time" } }, "required": [ "subnets", "updated_at" ], "example": { "subnets": [ "44.255.224.210/20", "100.113.203.15/26", "42.15.185.212" ], "updated_at": "2024-04-16T13:16:56.079093Z" } }, "DestinationListItem": { "type": "object", "description": "Destination object", "additionalProperties": false, "properties": { "id": { "description": "Destination ID", "type": "string", "pattern": "[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}", "minLength": 36, "maxLength": 150 }, "name": { "description": "Destination name", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 255 }, "description": { "description": "Destination description", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 0, "maxLength": 255 }, "type": { "description": "Destination type", "type": "string", "minLength": 1, "enum": [ "webhook", "smtp_ibm", "sms_ibm", "push_android", "push_ios", "slack", "ibmce", "pagerduty", "push_safari", "msteams", "servicenow", "ibmcos", "push_huawei", "smtp_custom", "smtp_custom_sandbox", "sms_custom", "event_streams", "app_configuration" ] }, "collect_failed_events": { "description": "Whether to collect the failed event in Cloud Object Storage bucket", "type": "boolean", "default": false }, "subscription_count": { "description": "Subscription count", "type": "integer", "format": "int32" }, "subscription_names": { "type": "array", "minItems": 0, "maxItems": 100, "description": "Names of subscriptions", "items": { "type": "string", "pattern": "[a-zA-Z0-9-:_].*", "minLength": 1 } }, "updated_at": { "description": "Updated at", "type": "string", "format": "date-time" } }, "required": [ "id", "name", "description", "type", "subscription_count", "subscription_names", "updated_at" ], "example": { "id": "11fe18ba-d0c8-4108-9f07-355e8052a813", "name": "Slack Webhook", "description": "This destination is for webhook purpose new", "type": "webhook", "subscription_count": 2, "subscription_names": [ "Webhook Sub for new change" ], "updated_at": "2021-09-05T00:25:19.599884Z" } }, "Source": { "type": "object", "description": "Payload describing a source generate request", "additionalProperties": false, "properties": { "id": { "description": "The id of the source", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 150 }, "name": { "description": "The name of the source", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 150 }, "description": { "description": "The description of the source", "type": "string", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "minLength": 1, "maxLength": 255 }, "enabled": { "description": "The status of the source", "type": "boolean" }, "store_notifications": { "description": "view the payload of incoming events for troubleshooting", "type": "boolean" }, "type": { "description": "Type of the source", "minLength": 1, "type": "string", "pattern": "[a-z.-].*" }, "updated_at": { "description": "The last updated time of the source", "type": "string", "format": "date-time" }, "topic_count": { "description": "The number of topics", "type": "integer", "format": "int32", "default": 0 }, "topic_names": { "type": "array", "description": "The names of the topics", "minItems": 0, "maxItems": 100, "items": { "type": "string", "minLength": 1, "pattern": "[a-zA-Z0-9-:_].*" } } }, "required": [ "id", "name", "description", "enabled", "type", "updated_at", "topic_count", "topic_names" ], "example": { "description": "this source is related cloud events", "enabled": false, "id": "00bb34e5-b8c1-4159-af15-8bc6980c3ab2:api", "name": "CloudEvents Source", "topic_count": 1, "topic_names": [ "updated1 apireview topic" ], "type": "api", "updated_at": "2021-09-14T20:43:47.484072Z" } }, "SourceList": { "type": "object", "description": "Payload describing a source list request", "additionalProperties": false, "properties": { "total_count": { "description": "Number of sources", "type": "integer", "minimum": 0, "format": "int32" }, "offset": { "type": "integer", "description": "Current offset", "format": "int32" }, "limit": { "type": "integer", "description": "limit to show sources", "format": "int32" }, "sources": { "type": "array", "description": "List of sources", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/SourceListItem" } }, "first": { "$ref": "#/components/schemas/PageHrefResponse" }, "previous": { "$ref": "#/components/schemas/PageHrefResponse" }, "next": { "$ref": "#/components/schemas/PageHrefResponse" } }, "required": [ "total_count", "limit", "offset", "sources" ], "example": { "total_count": 2, "limit": 10, "offset": 0, "sources": [ { "enabled": true, "description": "This source is related cloud events", "id": "00bb34e5-b8c1-4159-af15-8bc6980c3ab2:api", "name": "CloudEvents Source", "type": "api", "topic_count": 0, "updated_at": "2021-08-19T05:30:03.696492Z" }, { "enabled": true, "description": "This source is used to test integration tests", "id": "crn:v1:staging:public:compliance:us-south:a/41c340e7fb0b46d9a1a34eaa91fe94d4:2a555506-1d8b-457c-a16b-9d4ad05685ec::", "name": "Push Source1", "type": "bluemix.public.compliance", "topic_count": 1, "updated_at": "2021-08-18T19:14:13.916436Z" } ], "first": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/sources?limit=10&offset=0" }, "next": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/sources?limit=10&offset=10" } } }, "SourceListItem": { "type": "object", "description": "Payload describing a source list item", "additionalProperties": false, "properties": { "id": { "description": "ID of the source", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 150 }, "name": { "description": "Name of the source", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 100 }, "description": { "description": "Description of the source", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 255 }, "type": { "description": "Type of the source", "type": "string", "minLength": 1, "pattern": "[a-z.-_0-9].*" }, "enabled": { "description": "Whether the source is enabled or not", "type": "boolean" }, "store_notifications": { "description": "view the payload of incoming events for troubleshooting", "type": "boolean" }, "updated_at": { "description": "Time of the last update", "type": "string", "minLength": 1, "format": "date-time", "maxLength": 50 }, "topic_count": { "description": "Number of topics", "type": "integer", "format": "int32", "minimum": 0 } }, "required": [ "id", "name", "type", "enabled", "updated_at", "description", "topic_count" ], "example": { "id": "00bb34e5-b8c1-4159-af15-8bc6980c3ab2:api", "name": "CloudEvents Source", "description": "this source is related cloud events", "type": "api", "enabled": false, "topic_count": 1, "updated_at": "2021-09-14T20:43:47.484072Z" } }, "SourceResponse": { "type": "object", "description": "Payload describing a source", "additionalProperties": false, "properties": { "id": { "description": "ID of the source", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 150 }, "name": { "description": "Name of the source", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 100 }, "description": { "description": "Description of the source", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 255 }, "enabled": { "description": "Whether the source is enabled or not", "type": "boolean" }, "store_notifications": { "description": "view the payload of incoming events for troubleshooting", "type": "boolean" }, "created_at": { "description": "Time of the created", "type": "string", "minLength": 1, "format": "date-time", "maxLength": 50 } }, "required": [ "id", "name", "enabled", "created_at", "description" ], "example": { "id": "00bb34e5-b8c1-4159-af15-8bc6980c3ab2:api", "name": "CloudEvents Source", "description": "This source is related to cloud events", "enabled": false, "created_at": "2021-09-14T20:43:47.484072Z" } }, "SourceCreate": { "type": "object", "description": "Source object", "additionalProperties": false, "properties": { "name": { "description": "Name of the source", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*()]*", "maxLength": 255 }, "description": { "description": "Description of the source", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*()]*", "maxLength": 255 }, "enabled": { "description": "Whether the source is enabled or not", "type": "boolean", "default": true }, "store_notifications": { "description": "enable to view the payload of incoming events for troubleshooting", "type": "boolean", "default": false } }, "required": [ "name", "description" ], "example": { "name": "Event Notification Create Source Acme", "description": "This source is used for Acme Bank", "enabled": true } }, "SourceUpdate": { "type": "object", "description": "Source update object", "additionalProperties": false, "properties": { "name": { "description": "Name of the source", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*()]*", "maxLength": 255 }, "description": { "description": "Description of the source", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*()]*", "maxLength": 255 }, "enabled": { "description": "Whether the source is enabled or not", "type": "boolean", "default": true }, "store_notifications": { "description": "enable to view the payload of incoming events for troubleshooting", "type": "boolean", "default": false } }, "example": { "name": "Event Notification Create Source Acme", "description": "This source is used for Acme Bank", "enabled": false } }, "TopicCreate": { "type": "object", "description": "Topic object", "additionalProperties": false, "properties": { "name": { "description": "Name of the topic", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*()]*", "maxLength": 255 }, "description": { "description": "Description of the topic", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*()]*", "maxLength": 255 }, "sources": { "$ref": "#/components/schemas/Sources" } }, "required": [ "name" ], "example": { "name": "Event Notification Update Admin topic", "description": "This topic is used for EN spoof tests", "sources": [ { "id": "96dbf538-9fa7-4745-b9e4-32bb6f1dc47a:api", "rules": [ { "enabled": true, "event_type_filter": "$.notification_event_info.event_type == 'test'", "notification_filter": "$.notification.findings[0].severity == 'LOW'" }, { "enabled": false, "event_type_filter": "$.notification_event_info.event_type == 'test'", "notification_filter": "$.notification.findings[0].severity == 'HIGH'" }, { "enabled": true, "event_type_filter": "$.notification_event_info.event_type == 'cert_manager'" } ] } ] } }, "TopicUpdate": { "type": "object", "description": "Topic update object", "additionalProperties": false, "properties": { "name": { "description": "Name of the topic", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*()]*", "maxLength": 255 }, "description": { "description": "Description of the topic", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*()]*", "maxLength": 255 }, "sources": { "$ref": "#/components/schemas/Sources" } }, "example": { "sources": [ { "rules": [ { "enabled": true, "event_type_filter": "$.notification_event_info.event_type == 'cert_manager'", "notification_filter": "$.notification.findings[0].severity == 'MODERATE'" }, { "enabled": false, "event_type_filter": "$.notification_event_info.event_type == 'cert_manager'", "notification_filter": "$.notification.findings[0].severity == 'HIGH'" } ], "id": "e7c3b3ee-78d9-4e02-95c3-c001a05e6ea5:api" } ], "name": "Event Notification Topic", "description": "This topic is used for EN" } }, "TopicResponse": { "type": "object", "description": "Topic object", "additionalProperties": false, "properties": { "id": { "description": "Autogenerated topic ID", "type": "string", "minLength": 1, "pattern": "[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}", "maxLength": 50 }, "name": { "description": "Name of the topic", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*()]*", "maxLength": 255 }, "description": { "description": "Description of the topic", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*()]*", "maxLength": 255 }, "created_at": { "description": "Last time the topic was updated", "type": "string", "minLength": 1, "pattern": "[0-9A-Z:]*", "maxLength": 150 } }, "required": [ "id", "name", "description", "created_at" ], "example": { "created_at": "2021-10-07T06:51:37.707653235Z", "description": "This topic is used for EN e2e tests", "id": "81207685-7037-4d3a-b022-b7b974f6395b", "name": "EN Topic" } }, "SMTPVerificationUpdateResponse": { "type": "object", "description": "Payload describing SMTP verification response", "additionalProperties": false, "properties": { "status": { "description": "SMTP verification status", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/SMTPVerificationResponse" } } }, "required": [ "status" ], "example": { "status": [ { "type": "spf", "verification": "SUCCESSFUL" }, { "type": "dkim", "verification": "SUCCESSFUL" }, { "type": "en_authorization", "verification": "SUCCESSFUL" } ] } }, "VerificationResponse": { "type": "object", "description": "Destination verification object", "additionalProperties": false, "properties": { "type": { "description": "verification type", "type": "string", "minLength": 1, "pattern": "[a-z]", "maxLength": 20 }, "verification": { "description": "verification status", "type": "string", "minLength": 1, "pattern": "[A-Z]", "maxLength": 20 } }, "required": [ "type", "verification" ], "example": { "type": "dkim", "verification": "SUCCESSFUL" } }, "SMTPVerificationResponse": { "type": "object", "description": "verification object", "additionalProperties": false, "properties": { "type": { "description": "verification type", "type": "string", "minLength": 1, "pattern": ".*", "maxLength": 20 }, "verification": { "description": "verification status", "type": "string", "minLength": 1, "pattern": "[A-Z]", "maxLength": 20 } }, "required": [ "type", "verification" ], "example": { "type": "dkim", "verification": "SUCCESSFUL" } }, "Topic": { "type": "object", "description": "Topic object", "additionalProperties": false, "properties": { "id": { "description": "Autogenerated topic ID", "type": "string", "minLength": 1, "pattern": "[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}", "maxLength": 50 }, "description": { "description": "Description of the topic", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*()]*", "maxLength": 255 }, "name": { "description": "Name of the topic", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_]*", "maxLength": 50 }, "updated_at": { "description": "Last time the topic was updated", "type": "string", "minLength": 1, "pattern": "[0-9A-Z:]*", "maxLength": 150 }, "source_count": { "description": "Number of sources", "type": "integer", "default": 0 }, "sources": { "$ref": "#/components/schemas/SourcesList" }, "subscription_count": { "description": "Number of subscriptions", "type": "integer", "default": 0 }, "subscriptions": { "description": "List of subscriptions", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/SubscriptionListItem" } } }, "required": [ "id", "name", "description", "updated_at", "source_count", "sources", "subscription_count", "subscriptions" ], "example": { "description": "This topic is used for routing all compliance related notifications to the appropriate destinations", "id": "33d2b8d5-8ab8-46c7-97b9-c508afbf0701", "name": "Admin Topic Compliance", "source_count": 1, "sources": [ { "id": "96dbf538-9fa7-4745-b9e4-32bb6f1dc47a:api", "name": "Compliance source", "rules": [ { "enabled": true, "id": "218f4e30-9af2-4f70-b38b-738f923b0c4b", "event_type_filter": "$.notification_event_info.event_type == 'test'", "notification_filter": "$.notification.findings[0].severity == 'LOW'", "updated_at": "2021-09-08T13:25:20.523533Z" }, { "enabled": false, "id": "6a061e40-cf93-47b5-809b-59f11e9a4433", "event_type_filter": "$.notification_event_info.event_type == 'test'", "notification_filter": "$.notification.findings[0].severity == 'HIGH'", "updated_at": "2021-09-08T13:25:20.523533Z" }, { "enabled": true, "id": "6a061e40-cf93-47b5-809b-59f11e9a4433", "event_type_filter": "$.notification_event_info.event_type == 'cert_manager'", "notification_filter": "$.notification.findings[0].severity == 'MODERATE'", "updated_at": "2021-09-08T13:25:20.523533Z" } ] } ], "subscription_count": 1, "subscriptions": [ { "description": "This subscription is to send events from SCC to EN Admins via sms", "destination_id": "ec28efee-2236-4c2d-8839-d34f697cfc69", "destination_type": "sms_ibm", "id": "87bef75e-f826-4aa9-b64d-91af9be5e12b", "name": "SMS Subscription on new change", "topic_id": "7b23362d-6d48-47ef-847a-c8b291220306", "updated_at": "2021-08-20T10:08:46.060316Z" } ], "updated_at": "2021-09-08T13:25:20.475437Z" } }, "SourcesListItems": { "type": "object", "description": "Payload describing a source list item", "additionalProperties": false, "properties": { "id": { "description": "ID of the source", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 150 }, "name": { "description": "Name of the source", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 100 }, "rules": { "description": "List of rules", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/RulesGet" } } }, "required": [ "id", "name" ], "example": { "id": "96dbf538-9fa7-4745-b9e4-32bb6f1dc47a:api", "name": "Compliance source", "rules": [ { "enabled": true, "id": "218f4e30-9af2-4f70-b38b-738f923b0c4b", "event_type_filter": "$.notification_event_info.event_type == 'test'", "notification_filter": "$.notification.findings[0].severity == 'LOW'", "updated_at": "2021-09-08T13:25:20.523533Z" } ] } }, "SourcesList": { "description": "List of sources", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/SourcesListItems" } }, "SourcesItems": { "type": "object", "additionalProperties": false, "properties": { "id": { "description": "ID of the source", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*()]*", "maxLength": 255 }, "rules": { "description": "List of rules", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/Rules" } } }, "required": [ "id", "rules" ] }, "Sources": { "description": "List of sources", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/SourcesItems" }, "example": [ { "id": "e7c3b3ee-78d9-4e02-95c3-c001a05e6ea5:api", "rules": [ { "enabled": true, "event_type_filter": "$.notification_event_info.event_type == 'cert_manager'", "notification_filter": "$.notification.findings[0].severity == 'MODERATE'" }, { "enabled": false, "event_type_filter": "$.notification_event_info.event_type == 'cert_manager'", "notification_filter": "$.notification.findings[0].severity == 'HIGH'" } ] } ] }, "Rules": { "type": "object", "description": "Rule object", "additionalProperties": false, "properties": { "enabled": { "description": "Whether the rule is enabled or not", "type": "boolean", "default": true }, "event_type_filter": { "description": "Event type filter", "type": "string", "minLength": 3, "pattern": "[a-zA-Z 0-9-_$.=']*", "maxLength": 255, "default": "$.*" }, "notification_filter": { "description": "Notification filter", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_$.=']*", "maxLength": 255 }, "event_schedule_filter": { "$ref": "#/components/schemas/EventScheduleFilterAttributes" } }, "example": { "enabled": true, "event_type_filter": "$.notification_event_info.event_type == 'cert_manager'", "notification_filter": "$.notification.findings[0].severity == 'MODERATE'" } }, "RulesGet": { "type": "object", "description": "Rule object", "additionalProperties": false, "properties": { "enabled": { "description": "Whether the rule is enabled or not", "type": "boolean" }, "event_type_filter": { "description": "Event type filter", "type": "string", "minLength": 3, "pattern": "[a-zA-Z 0-9-_$.=']*", "maxLength": 255, "default": "$.*" }, "notification_filter": { "description": "Notification filter", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_$.=']*", "maxLength": 255 }, "event_schedule_filter": { "$ref": "#/components/schemas/EventScheduleFilterAttributes" }, "updated_at": { "description": "Last time the topic was updated", "type": "string", "minLength": 1, "pattern": "[0-9A-Z:]*", "maxLength": 150 }, "id": { "description": "Autogenerated rule ID", "type": "string", "minLength": 1, "pattern": "[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}", "maxLength": 150 } }, "required": [ "enabled", "updated_at", "id" ], "example": { "enabled": true, "event_type_filter": "$.notification_event_info.event_type == 'cert_manager'", "notification_filter": "$.notification.findings[0].severity == 'MODERATE'", "updated_at": "2021-08-20T10:08:46.060316Z", "id": "e7c3b3ee-78d9-4e02-95c3-c001a05e6ea5" } }, "Buckets": { "type": "object", "description": "Bucket object", "additionalProperties": false, "properties": { "doc_count": { "type": "integer", "format": "int32", "description": "Total count" }, "key_as_string": { "type": "string", "format": "date-time", "description": "Timestamp" } } }, "TopicList": { "type": "object", "description": "Topic list object", "additionalProperties": false, "properties": { "total_count": { "description": "Number of topics", "type": "integer", "minimum": 0, "format": "int32" }, "offset": { "type": "integer", "description": "Current offset", "format": "int32" }, "limit": { "type": "integer", "description": "limit to show subscriptions", "format": "int32" }, "topics": { "type": "array", "description": "List of topics", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/TopicsListItem" } }, "first": { "$ref": "#/components/schemas/PageHrefResponse" }, "previous": { "$ref": "#/components/schemas/PageHrefResponse" }, "next": { "$ref": "#/components/schemas/PageHrefResponse" } }, "required": [ "total_count", "offset", "limit", "topics" ], "example": { "total_count": 2, "offset": 0, "limit": 10, "topics": [ { "source_count": 2, "sources_names": [ "Push Source", "Custom source" ], "subscription_count": 3, "description": "To send events to all EN developers", "id": "33d2b8d5-8ab8-46c7-97b9-c508afbf0701", "name": "Developers topic" }, { "source_count": 1, "sources_names": [ "Push Source1" ], "subscription_count": 3, "description": "This topic is used for EN integration tests", "id": "7b23362d-6d48-47ef-847a-c8b291220306", "name": "Event Notification Admin encryption1" } ], "first": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/topics?limit=10&offset=0" }, "next": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/topics?limit=10&offset=10" } } }, "TopicsListItem": { "type": "object", "description": "Topic list item object", "additionalProperties": false, "properties": { "id": { "description": "Autogenerated topic ID", "type": "string", "minLength": 1, "pattern": "[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}", "maxLength": 50 }, "name": { "description": "Name of the topic", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*()]*", "maxLength": 255 }, "description": { "description": "Description of the topic", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*()]*", "maxLength": 255 }, "source_count": { "description": "Number of sources", "type": "integer", "minimum": 0, "format": "int32", "maximum": 1024 }, "sources_names": { "description": "List of source names", "type": "array", "minItems": 0, "maxItems": 100, "items": { "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*()]*", "maxLength": 255 } }, "subscription_count": { "description": "Number of subscriptions", "type": "integer", "minimum": 0, "format": "int32", "maximum": 1024 } }, "required": [ "id", "name", "description", "source_count", "sources_names", "subscription_count" ], "example": { "id": "33d2b8d5-8ab8-46c7-97b9-c508afbf0701", "name": "updated1 apireview topic", "description": "thiis is epic", "source_count": 1, "subscription_count": 3, "sources_names": [ "Push Source1" ] } }, "SMSUpdateAttributes": { "type": "object", "description": "SMS attributes object", "additionalProperties": false, "properties": { "invited": { "$ref": "#/components/schemas/UpdateAttributesInvited" }, "subscribed": { "$ref": "#/components/schemas/UpdateAttributesSubscribed" }, "unsubscribed": { "$ref": "#/components/schemas/UpdateAttributesUnsubscribed" } }, "example": { "invited": { "add": [ "+89121912010" ], "remove": [ "+1219112981981", "+91210910232312" ] }, "subscribed": { "remove": [ "+1219112981983", "+91210910232314" ] }, "unsubscribed": { "remove": [ "+1219112981983", "+91210910232314" ] } } }, "CustomSMSUpdateAttributes": { "type": "object", "description": "SMS attributes object", "additionalProperties": false, "properties": { "invited": { "$ref": "#/components/schemas/UpdateAttributesInvited" }, "subscribed": { "$ref": "#/components/schemas/UpdateAttributesSubscribed" }, "unsubscribed": { "$ref": "#/components/schemas/UpdateAttributesUnsubscribed" } }, "example": { "invited": { "add": [ "+89121912010" ], "remove": [ "+1219112981981", "+91210910232312" ] }, "subscribed": { "remove": [ "+1219112981983", "+91210910232314" ] }, "unsubscribed": { "remove": [ "+1219112981983", "+91210910232314" ] } } }, "FCMAttributes": { "description": "The attributes for an FCM notification", "type": "object", "additionalProperties": false, "properties": {}, "example": {} }, "DKIMAttributes": { "type": "object", "description": "The DKIM attributes", "additionalProperties": false, "properties": { "public_key": { "description": "dkim public key", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 500 }, "selector": { "description": "dkim selector", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 500 }, "verification": { "description": "dkim verification", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 255 } } }, "SPFAttributes": { "type": "object", "description": "The SPF attributes", "additionalProperties": false, "properties": { "txt_name": { "description": "spf text name", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 255 }, "txt_value": { "description": "spf text value", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 500 }, "verification": { "description": "spf verification", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 255 } } }, "SMTPDKIMAttributes": { "type": "object", "description": "The SMTP DKIM attributes", "additionalProperties": false, "properties": { "txt_name": { "description": "DKIM text name", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 255 }, "txt_value": { "description": "DKIM text value", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 500 }, "verification": { "description": "DKIM verification", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 255 } } }, "ENAuthAttributes": { "type": "object", "description": "The en_authorization attributes", "additionalProperties": false, "properties": { "verification": { "description": "en_authorization verification", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 255 } } }, "EventScheduleFilterAttributes": { "type": "object", "description": "Event schedule filter attributes", "additionalProperties": false, "properties": { "starts_at": { "type": "string", "description": "event schedule start time", "format": "date-time", "minLength": 1, "maxLength": 25 }, "ends_at": { "type": "string", "description": "event schedule end time", "format": "date-time", "minLength": 1, "maxLength": 25 }, "expression": { "type": "string", "description": "cron schedule expression", "pattern": ".*", "minLength": 1, "maxLength": 100 } } }, "UpdateAttributesInvited": { "type": "object", "description": "The email ids or phone numbers", "additionalProperties": false, "properties": { "add": { "description": "The email ids or phone numbers to be invited", "type": "array", "minItems": 0, "maxItems": 100, "items": { "type": "string", "minLength": 1, "pattern": ".*", "maxLength": 150 } }, "remove": { "description": "The email ids or phone numbers for removal", "type": "array", "minItems": 0, "maxItems": 100, "items": { "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 150 } } } }, "UpdateAttributesSubscribed": { "description": "The email ids or phone numbers", "additionalProperties": false, "properties": { "remove": { "description": "The email ids or phone numbers to be unsubscribed", "type": "array", "minItems": 0, "maxItems": 100, "items": { "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 150 } } } }, "EmailAttributesResponseSubscribedUnsubscribedItems": { "type": "object", "properties": { "email": { "type": "string", "description": "email address", "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$", "minLength": 1, "maxLength": 255 }, "updated_at": { "type": "string", "description": "last updated time", "format": "date-time", "minLength": 1, "maxLength": 255 } } }, "UpdateAttributesUnsubscribed": { "description": "The email ids or phone numbers", "additionalProperties": false, "properties": { "remove": { "description": "The email ids or phone numbers to be unsubscribed", "type": "array", "minItems": 0, "maxItems": 100, "items": { "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 150 } } } }, "EmailUpdateAttributes": { "description": "The attributes for an email notification", "type": "object", "additionalProperties": false, "properties": { "invited": { "$ref": "#/components/schemas/UpdateAttributesInvited" }, "add_notification_payload": { "description": "Whether to add the notification payload to the email", "type": "boolean", "default": false }, "reply_to_mail": { "description": "The email address to reply to", "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$" }, "reply_to_name": { "description": "The email name to reply to", "type": "string", "pattern": "[a-zA-Z0-9-:_]*", "maxLength": 150, "minLength": 1 }, "from_name": { "description": "The email name of From", "type": "string", "pattern": "[a-zA-Z0-9-:_]*", "maxLength": 150, "minLength": 1 }, "subscribed": { "$ref": "#/components/schemas/UpdateAttributesSubscribed" }, "unsubscribed": { "$ref": "#/components/schemas/UpdateAttributesUnsubscribed" } }, "required": [ "add_notification_payload", "reply_to_mail", "reply_to_name", "from_name" ], "example": { "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 } }, "CustomEmailUpdateAttributes": { "description": "The attributes for an email notification", "type": "object", "additionalProperties": false, "properties": { "invited": { "$ref": "#/components/schemas/UpdateAttributesInvited" }, "add_notification_payload": { "description": "Whether to add the notification payload to the email", "type": "boolean", "default": false }, "reply_to_mail": { "description": "The email address to reply to", "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$" }, "reply_to_name": { "description": "The email name to reply to", "type": "string", "pattern": "[a-zA-Z0-9-:_]*", "maxLength": 150, "minLength": 1 }, "from_name": { "description": "The email name of From", "type": "string", "pattern": "[a-zA-Z0-9-:_]*", "maxLength": 150, "minLength": 1 }, "from_email": { "description": "The email from", "type": "string", "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$", "minLength": 1, "maxLength": 255 }, "subscribed": { "$ref": "#/components/schemas/UpdateAttributesSubscribed" }, "unsubscribed": { "$ref": "#/components/schemas/UpdateAttributesUnsubscribed" }, "template_id_notification": { "description": "The templete id for notification", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 }, "template_id_invitation": { "description": "The templete id for invitation", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 } }, "required": [ "add_notification_payload", "reply_to_mail", "reply_to_name", "from_name", "from_email" ], "example": { "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" } }, "CustomEmailSandboxUpdateAttributes": { "description": "The attributes for an email notification", "type": "object", "additionalProperties": false, "properties": { "invited": { "$ref": "#/components/schemas/UpdateAttributesInvited" }, "add_notification_payload": { "description": "Whether to add the notification payload to the email", "type": "boolean", "default": false }, "reply_to_mail": { "description": "The email address to reply to", "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$" }, "reply_to_name": { "description": "The email name to reply to", "type": "string", "pattern": "[a-zA-Z0-9-:_]*", "maxLength": 150, "minLength": 1 }, "subscribed": { "$ref": "#/components/schemas/UpdateAttributesSubscribed" }, "unsubscribed": { "$ref": "#/components/schemas/UpdateAttributesUnsubscribed" }, "template_id_notification": { "description": "The templete id for notification", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 }, "template_id_invitation": { "description": "The templete id for invitation", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 } }, "required": [ "add_notification_payload", "reply_to_mail", "reply_to_name" ], "example": { "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" } }, "SMSAttributes": { "description": "The attributes for an sms notification", "type": "object", "additionalProperties": false, "properties": { "invited": { "description": "The sms id string", "type": "array", "minItems": 0, "maxItems": 100, "items": { "type": "string", "minLength": 1, "description": "Phone numbers", "pattern": ".*", "maxLength": 150 } } }, "required": [ "invited" ], "example": { "invited": [ "+91298198291", "+12918219" ] } }, "CustomSMSAttributes": { "description": "The attributes for an custom sms notification", "type": "object", "additionalProperties": false, "properties": { "invited": { "description": "The sms id string", "type": "array", "minItems": 0, "maxItems": 100, "items": { "type": "string", "minLength": 1, "description": "Phone numbers", "pattern": ".*", "maxLength": 15 } } }, "required": [ "invited" ], "example": { "invited": [ "+91298198291", "+12918219" ] } }, "EmailAttributes": { "description": "The attributes for an email notification", "type": "object", "additionalProperties": false, "properties": { "invited": { "description": "The email id string", "type": "array", "minItems": 0, "maxItems": 100, "items": { "type": "string", "description": "email IDs", "minLength": 1, "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$", "maxLength": 150 } }, "add_notification_payload": { "description": "Whether to add the notification payload to the email", "type": "boolean", "default": false }, "reply_to_mail": { "description": "The email address to reply to", "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$" }, "reply_to_name": { "description": "The email name to reply to", "type": "string", "pattern": "[a-zA-Z0-9-:_]*", "minLength": 1, "maxLength": 150 }, "from_name": { "description": "The email name of From", "type": "string", "pattern": "[a-zA-Z0-9-:_]*", "minLength": 1, "maxLength": 150 } }, "required": [ "invited", "add_notification_payload", "reply_to_mail", "reply_to_name", "from_name" ], "example": { "invited": [ "example1@gmail.com", "example2@gmail.com" ], "reply_to_mail": "example@ibm.com", "reply_to_name": "USA news", "from_name": "IBM", "add_notification_payload": true } }, "CustomEmailAttributes": { "description": "The attributes for an email notification", "type": "object", "additionalProperties": false, "properties": { "invited": { "description": "The email id string", "type": "array", "minItems": 0, "maxItems": 100, "items": { "type": "string", "description": "email IDs", "minLength": 1, "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$", "maxLength": 150 } }, "add_notification_payload": { "description": "Whether to add the notification payload to the email", "type": "boolean", "default": false }, "reply_to_mail": { "description": "The email address to reply to", "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$" }, "reply_to_name": { "description": "The email name to reply to", "type": "string", "pattern": "[a-zA-Z0-9-:_]*", "minLength": 1, "maxLength": 150 }, "from_name": { "description": "The email name of From", "type": "string", "pattern": "[a-zA-Z0-9-:_]*", "minLength": 1, "maxLength": 150 }, "from_email": { "description": "The email from", "type": "string", "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$", "minLength": 1, "maxLength": 255 }, "template_id_notification": { "description": "The templete id for notification", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 }, "template_id_invitation": { "description": "The templete id for invitation", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 } }, "required": [ "invited", "add_notification_payload", "reply_to_mail", "reply_to_name", "from_name", "from_email" ], "example": { "invited": [ "example1@gmail.com", "example2@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" } }, "CustomEmailSandboxAttributes": { "description": "The attributes for an email notification", "type": "object", "additionalProperties": false, "properties": { "invited": { "description": "The email id string", "type": "array", "minItems": 0, "maxItems": 100, "items": { "type": "string", "description": "email IDs", "minLength": 1, "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$", "maxLength": 150 } }, "add_notification_payload": { "description": "Whether to add the notification payload to the email", "type": "boolean", "default": false }, "reply_to_mail": { "description": "The email address to reply to", "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$" }, "reply_to_name": { "description": "The email name to reply to", "type": "string", "pattern": "[a-zA-Z0-9-:_]*", "minLength": 1, "maxLength": 150 }, "template_id_notification": { "description": "The templete id for notification", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 }, "template_id_invitation": { "description": "The templete id for invitation", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 } }, "required": [ "invited", "add_notification_payload", "reply_to_mail", "reply_to_name" ], "example": { "invited": [ "example1@gmail.com", "example2@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" } }, "SMSAttributesItems": { "type": "object", "description": "The sms attributes", "properties": { "phone_number": { "type": "string", "description": "Phone number", "pattern": ".*", "minLength": 1, "maxLength": 255 }, "updated_at": { "type": "string", "description": "last updated time", "format": "date-time", "minLength": 1, "maxLength": 255 } } }, "SMSInviteAttributesItems": { "type": "object", "description": "The sms attributes", "properties": { "phone_number": { "type": "string", "description": "Phone number", "pattern": ".*", "minLength": 1, "maxLength": 255 }, "updated_at": { "type": "string", "description": "last updated time", "format": "date-time", "minLength": 1, "maxLength": 255 }, "expires_at": { "type": "string", "description": "time of expiration", "format": "date-time", "minLength": 1, "maxLength": 255 } } }, "SMSAttributesResponse": { "type": "object", "description": "SMS attributes object", "additionalProperties": false, "properties": { "subscribed": { "description": "The subscribed list", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/SMSAttributesItems" } }, "unsubscribed": { "description": "The unsubscribe list", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/SMSAttributesItems" } }, "invited": { "description": "The SMS numder string", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/SMSInviteAttributesItems" } } }, "example": { "invited": [ { "phone_number": "+19821983202", "updated_at": "2022-09-19T23:27:08.458173+05:30", "expires_at": "2022-09-26T23:26:08.458173+05:30" } ], "subscribed": [ { "phone_number": "+19821983202", "updated_at": "2022-09-19T23:27:08.458173+05:30" } ], "unsubscribed": [ { "phone_number": "+19821983203", "updated_at": "2022-09-19T23:28:08.458173+05:30" } ] } }, "CustomSMSAttributesResponse": { "type": "object", "description": "Custom SMS attributes object", "additionalProperties": false, "properties": { "subscribed": { "description": "The subscribed list", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/SMSAttributesItems" } }, "unsubscribed": { "description": "The unsubscribe list", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/SMSAttributesItems" } }, "invited": { "description": "The SMS number string", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/SMSInviteAttributesItems" } } }, "example": { "invited": [ { "phone_number": "+19821983202", "updated_at": "2022-09-19T23:27:08.458173+05:30", "expires_at": "2022-09-26T23:26:08.458173+05:30" } ], "subscribed": [ { "phone_number": "+19821983202", "updated_at": "2022-09-19T23:27:08.458173+05:30" } ], "unsubscribed": [ { "phone_number": "+19821983203", "updated_at": "2022-09-19T23:28:08.458173+05:30" } ] } }, "EmailAttributesResponseInvitedItems": { "type": "object", "properties": { "email": { "type": "string", "description": "email address", "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$", "minLength": 1, "maxLength": 255 }, "updated_at": { "type": "string", "description": "last updated time", "format": "date-time", "minLength": 1, "maxLength": 255 }, "expires_at": { "type": "string", "description": "time of expiration", "format": "date-time", "minLength": 1, "maxLength": 255 } } }, "EmailAttributesResponse": { "description": "The attributes reponse for an email destination", "type": "object", "additionalProperties": false, "properties": { "invited": { "description": "The email id string", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/EmailAttributesResponseInvitedItems" } }, "subscribed": { "description": "The unsubscribe list", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/EmailAttributesResponseSubscribedUnsubscribedItems" } }, "unsubscribed": { "description": "The subscribed list", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/EmailAttributesResponseSubscribedUnsubscribedItems" } }, "add_notification_payload": { "description": "Whether to add the notification payload to the email", "type": "boolean", "default": false }, "reply_to_mail": { "description": "The email address to reply to", "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$" }, "reply_to_name": { "description": "The email name to reply to", "type": "string", "pattern": "[a-zA-Z0-9-:_]*", "minLength": 1, "maxLength": 150 }, "from_name": { "description": "The email name of From", "type": "string", "pattern": "[a-zA-Z0-9-:_]*", "minLength": 1, "maxLength": 150 } }, "required": [ "add_notification_payload", "reply_to_mail", "reply_to_name", "from_name" ], "example": { "invited": [ { "email": "example1@gmail.com", "updated_at": "2022-09-19T23:26:08.458173+05:30", "expires_at": "2022-09-26T23:26:08.458173+05:30" } ], "subscribed": [ { "email": "example2@gmail.com", "updated_at": "2022-09-20T00:14:01.490156+05:30" } ], "unsubscribed": [ { "email": "example3@gmail.com", "updated_at": "2022-09-20T00:15:45.2301+05:30" } ], "reply_to_mail": "example@ibm.com", "reply_to_name": "USA news", "from_name": "IBM", "add_notification_payload": true } }, "CustomEmailAttributesResponse": { "description": "The attributes reponse for an email destination", "type": "object", "additionalProperties": false, "properties": { "invited": { "description": "The email id string", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/EmailAttributesResponseInvitedItems" } }, "subscribed": { "description": "The unsubscribe list", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/EmailAttributesResponseSubscribedUnsubscribedItems" } }, "unsubscribed": { "description": "The subscribed list", "type": "array", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/EmailAttributesResponseSubscribedUnsubscribedItems" } }, "add_notification_payload": { "description": "Whether to add the notification payload to the email", "type": "boolean", "default": false }, "reply_to_mail": { "description": "The email address to reply to", "type": "string", "minLength": 1, "maxLength": 255, "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$" }, "reply_to_name": { "description": "The email name to reply to", "type": "string", "pattern": "[a-zA-Z0-9-:_]*", "minLength": 1, "maxLength": 150 }, "from_name": { "description": "The email name of From", "type": "string", "pattern": "[a-zA-Z0-9-:_]*", "minLength": 1, "maxLength": 150 }, "from_email": { "description": "The email from", "type": "string", "pattern": "^[a-zA-Z0-9+_.-]+@[a-zA-Z0-9.-]+$", "minLength": 1, "maxLength": 255 }, "template_id_notification": { "description": "The templete id for notification", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 }, "template_id_invitation": { "description": "The templete id for invitation", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 } }, "required": [ "add_notification_payload", "reply_to_mail", "reply_to_name", "from_name", "from_email" ], "example": { "invited": [ { "email": "example1@gmail.com", "updated_at": "2022-09-19T23:26:08.458173+05:30", "expires_at": "2022-09-26T23:26:08.458173+05:30" } ], "subscribed": [ { "email": "example2@gmail.com", "updated_at": "2022-09-20T00:14:01.490156+05:30" } ], "unsubscribed": [ { "email": "example3@gmail.com", "updated_at": "2022-09-20T00:15:45.2301+05:30" } ], "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" } }, "WebhookAttributes": { "type": "object", "description": "The attributes for a webhook notification", "additionalProperties": false, "properties": { "signing_enabled": { "description": "Signing webhook attributes", "type": "boolean" }, "template_id_notification": { "description": "ID of Base64 converted JSON webhook Blocks w/o Handlebars", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 } }, "example": { "signing_enabled": true, "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13" } }, "SlackAttributes": { "type": "object", "description": "The attributes for a slack notification", "additionalProperties": false, "properties": { "attachment_color": { "description": "Attachment Color for the slack message", "type": "string", "pattern": ".*", "minLength": 3, "maxLength": 15 }, "template_id_notification": { "description": "ID of Base64 converted JSON Slack Blocks w/o Handlebars", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 } }, "example": { "attachment_color": "#0000FF", "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13" } }, "PagerDutyAttributes": { "type": "object", "description": "The attributes for a pagerduty notification", "additionalProperties": false, "properties": { "template_id_notification": { "description": "ID of Base64 converted JSON Slack Blocks w/o Handlebars", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 } }, "example": { "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13" } }, "EventstreamsAttributes": { "type": "object", "description": "The attributes for a Event Streams subscription", "additionalProperties": false, "properties": { "template_id_notification": { "description": "Event Streams template id", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 } }, "example": { "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13" } }, "AppConfigurationAttributes": { "type": "object", "description": "The attributes for a App Configuration subscription", "additionalProperties": false, "properties": { "feature_flag_enabled": { "description": "App Configuration enable feature flag attribute", "type": "boolean" }, "template_id_notification": { "description": "App Configuration template id", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 } }, "example": { "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13" } }, "CodeEngineAttributes": { "type": "object", "description": "The attributes for a Code Engine subscription", "additionalProperties": false, "properties": { "template_id_notification": { "description": "code engine template id", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 } }, "example": { "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13" } }, "SlackDirectMessageAttributes": { "type": "object", "description": "The attributes for a slack direct message", "additionalProperties": false, "properties": { "channels": { "description": "List of channels", "type": "array", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/ChannelCreateAttributes" } }, "template_id_notification": { "description": "ID of Base64 converted JSON Slack Blocks w/o Handlebars", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 } }, "example": { "template_id_notification": "5dc1a066-c64a-430f-a180-0babc155ba72", "channels": [ { "id": "B9013WO39V4H" }, { "id": "63MU8ESQEJ49" } ] } }, "SlackDirectMessageUpdateAttributes": { "type": "object", "description": "The attributes for a slack direct message", "additionalProperties": false, "properties": { "channels": { "description": "List of channels", "type": "array", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/ChannelUpdateAttributes" } }, "template_id_notification": { "description": "ID of Base64 converted JSON Slack Blocks w/o Handlebars", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 } }, "example": { "template_id_notification": "5dc1a066-c64a-430f-a180-0babc155ba72", "channels": [ { "id": "B9013WO39V4H", "operation": "add" }, { "id": "63MU8ESQEJ49", "operation": "remove" } ] } }, "ServiceNowAttributes": { "type": "object", "description": "The attributes for a ServiceNow notification", "additionalProperties": false, "properties": { "assigned_to": { "description": "Name of user ServiceNow incident will be assigned to", "type": "string", "pattern": ".*", "minLength": 3, "maxLength": 150 }, "assignment_group": { "description": "Group Name to which incident will be assigned to", "type": "string", "pattern": ".*", "minLength": 3, "maxLength": 150 } } }, "WebhookAttributesResponse": { "type": "object", "description": "The attributes for a webhook notification", "additionalProperties": false, "properties": { "signing_enabled": { "description": "Signing webhook attributes", "type": "boolean" }, "add_notification_payload": { "description": "Decision for Notification Payload to be added", "type": "boolean" } }, "required": [ "signing_enabled", "add_notification_payload" ], "example": { "signing_enabled": true, "add_notification_payload": true } }, "SlackAttributesResponse": { "type": "object", "description": "The attributes for a Slack notification", "additionalProperties": false, "properties": { "attachment_color": { "description": "Attachment Color for Slack Notification", "type": "string" }, "template_id_notification": { "description": "ID of Base64 converted JSON Slack Blocks w/o Handlebars", "type": "string" } }, "example": { "attachment_color": "#0000FF", "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13" } }, "PagerDutyAttributesResponse": { "type": "object", "description": "The attributes for a PagerDuty notification", "additionalProperties": false, "properties": { "template_id_notification": { "description": "ID of Base64 converted JSON Pagerduty Blocks w/o Handlebars", "type": "string" } }, "example": { "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13" } }, "EventStreamsAttributesResponse": { "type": "object", "description": "The attributes for a Event Streams response", "additionalProperties": false, "properties": { "template_id_notification": { "description": "Event Streams template id", "type": "string" } }, "example": { "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13" } }, "AppConfigurationAttributesResponse": { "type": "object", "description": "The attributes for a App Configuration notification", "additionalProperties": false, "properties": { "feature_flag_enabled": { "description": "App Configuration enable feature flag attribute", "type": "boolean" }, "template_id_notification": { "description": "App Configuration template id", "type": "string" } }, "example": { "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13" } }, "CodeEngineAttributesResponse": { "type": "object", "description": "The attributes for a Code Engine response", "additionalProperties": false, "properties": { "template_id_notification": { "description": "Code Engine template id", "type": "string" } }, "example": { "template_id_notification": "a59f6e38-7a48-xxxx-b665-3724afc58b13" } }, "SlackDirectMessageAttributesResponse": { "type": "object", "description": "The attributes for a slack direct message", "additionalProperties": false, "properties": { "channels": { "description": "List of channels", "type": "array", "minItems": 1, "maxItems": 100, "items": { "$ref": "#/components/schemas/ChannelCreateAttributes" } }, "template_id_notification": { "description": "ID of Base64 converted JSON Slack Blocks w/o Handlebars", "type": "string", "pattern": ".*", "minLength": 0, "maxLength": 36 } }, "example": { "template_id_notification": "5dc1a066-c64a-430f-a180-0babc155ba72", "channels": [ { "id": "B9013WO39V4H" }, { "id": "63MU8ESQEJ49" } ] } }, "ServiceNowAttributesResponse": { "type": "object", "description": "The attributes for a ServiceNow notification", "additionalProperties": false, "properties": { "assigned_to": { "description": "Assigned name from ServiceNow account", "type": "string" }, "assignment_group": { "description": "Assigned group name from ServiceNow account", "type": "string" } } }, "SubscriptionAttributes": { "additionalProperties": true, "oneOf": [ { "$ref": "#/components/schemas/SMSAttributesResponse" }, { "$ref": "#/components/schemas/CustomSMSAttributesResponse" }, { "$ref": "#/components/schemas/EmailAttributesResponse" }, { "$ref": "#/components/schemas/CustomEmailAttributesResponse" }, { "$ref": "#/components/schemas/WebhookAttributesResponse" }, { "$ref": "#/components/schemas/SlackAttributesResponse" }, { "$ref": "#/components/schemas/PagerDutyAttributesResponse" }, { "$ref": "#/components/schemas/SlackDirectMessageAttributesResponse" }, { "$ref": "#/components/schemas/ServiceNowAttributesResponse" }, { "$ref": "#/components/schemas/EventStreamsAttributesResponse" }, { "$ref": "#/components/schemas/CodeEngineAttributesResponse" }, { "$ref": "#/components/schemas/AppConfigurationAttributesResponse" } ] }, "Subscription": { "type": "object", "description": "Subscription object", "additionalProperties": true, "properties": { "id": { "description": "Subscription ID", "type": "string", "minLength": 1, "pattern": "[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}", "maxLength": 150 }, "name": { "description": "Subscription name", "type": "string", "minLength": 1, "pattern": "[a-zA-Z0-9-:_]*", "maxLength": 150 }, "description": { "description": "Subscription description", "type": "string", "minLength": 1, "maxLength": 255 }, "updated_at": { "description": "Last updated time", "type": "string", "minLength": 1, "pattern": "[0-9A-Z:]*", "maxLength": 100 }, "from": { "description": "From Email ID (it will be displayed only in case of smtp_ibm destination type)", "type": "string", "minLength": 1, "pattern": "[a-zA-Z0-9-:_]*", "maxLength": 150 }, "destination_type": { "description": "The type of destination", "type": "string", "minLength": 1, "enum": [ "sms_ibm", "smtp_ibm", "webhook", "push_android", "push_ios", "push_chrome", "push_firefox", "slack", "ibmce", "pagerduty", "push_safari", "msteams", "servicenow", "ibmcos", "push_huawei", "smtp_custom", "smtp_custom_sandbox", "sms_custom", "event_streams", "app_configuration" ] }, "destination_id": { "description": "The destination ID", "type": "string", "minLength": 1, "pattern": "[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}", "maxLength": 150 }, "destination_name": { "description": "The destination name", "type": "string", "minLength": 1, "pattern": "[a-zA-Z0-9-:_]*", "maxLength": 255 }, "topic_id": { "description": "Topic ID", "type": "string", "minLength": 1, "pattern": "[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}", "maxLength": 150 }, "topic_name": { "description": "Topic name", "type": "string", "pattern": "[a-zA-Z0-9-:_]*", "maxLength": 255 }, "attributes": { "$ref": "#/components/schemas/SubscriptionAttributes" } }, "required": [ "id", "name", "description", "updated_at", "destination_type", "destination_id", "destination_name", "topic_id", "topic_name" ], "example": { "attributes": { "signing_enabled": true, "add_notification_payload": true }, "description": "Subscribing destinations with Admin Topic Compliance", "destination_id": "0bc82d4e-6e81-415d-9fe3-b530a73fabe9", "destination_name": "Admin email", "destination_type": "smtp_ibm", "id": "87bef75e-f826-4aa9-b64d-91af9be5e12b", "name": "Admin Email Subscription Compliance", "topic_id": "966378be-5b02-41b6-9449-d71d7da5c247", "topic_name": "SCC Certificate ", "updated_at": "2021-08-20T10:08:46.060316Z" } }, "SubscriptionUpdateAttributes": { "oneOf": [ { "$ref": "#/components/schemas/SMSUpdateAttributes" }, { "$ref": "#/components/schemas/EmailUpdateAttributes" }, { "$ref": "#/components/schemas/CustomSMSUpdateAttributes" }, { "$ref": "#/components/schemas/CustomEmailUpdateAttributes" }, { "$ref": "#/components/schemas/CustomEmailSandboxUpdateAttributes" }, { "$ref": "#/components/schemas/WebhookAttributes" }, { "$ref": "#/components/schemas/SlackAttributes" }, { "$ref": "#/components/schemas/PagerDutyAttributes" }, { "$ref": "#/components/schemas/SlackDirectMessageUpdateAttributes" }, { "$ref": "#/components/schemas/ServiceNowAttributes" }, { "$ref": "#/components/schemas/EventstreamsAttributes" }, { "$ref": "#/components/schemas/CodeEngineAttributes" }, { "$ref": "#/components/schemas/AppConfigurationAttributes" } ] }, "SubscriptionUpdate": { "type": "object", "description": "Subscription object", "properties": { "name": { "description": "Name of the subscription", "type": "string", "minLength": 1, "pattern": "[a-zA-Z0-9-:_]*", "maxLength": 100 }, "description": { "description": "Description of the subscription", "type": "string", "minLength": 1, "pattern": "[a-zA-Z0-9-:_]*", "maxLength": 100 }, "attributes": { "$ref": "#/components/schemas/SubscriptionUpdateAttributes" } }, "example": { "name": "Admin Email Subscription Compliance", "description": "Subscribing destinations with Admin Topic Compliance", "attributes": { "invited": { "add": [ "example4@gmail.com" ], "remove": [ "example4@gmail.com" ] }, "subscribed": { "remove": [ "example2@gmail.com" ] }, "unsubscribed": { "remove": [ "example1@ibm.com" ] }, "add_notification_payload": true, "reply_to_mail": "example@ibm.com", "reply_to_name": "USA news", "from_name": "IBM", "from_email": "test@email.com" } } }, "SubscriptionCreateAttributes": { "oneOf": [ { "$ref": "#/components/schemas/SMSAttributes" }, { "$ref": "#/components/schemas/EmailAttributes" }, { "$ref": "#/components/schemas/CustomSMSAttributes" }, { "$ref": "#/components/schemas/CustomEmailAttributes" }, { "$ref": "#/components/schemas/CustomEmailSandboxAttributes" }, { "$ref": "#/components/schemas/WebhookAttributes" }, { "$ref": "#/components/schemas/FCMAttributes" }, { "$ref": "#/components/schemas/SlackAttributes" }, { "$ref": "#/components/schemas/PagerDutyAttributes" }, { "$ref": "#/components/schemas/SlackDirectMessageAttributes" }, { "$ref": "#/components/schemas/ServiceNowAttributes" }, { "$ref": "#/components/schemas/EventstreamsAttributes" }, { "$ref": "#/components/schemas/CodeEngineAttributes" }, { "$ref": "#/components/schemas/AppConfigurationAttributes" } ] }, "SubscriptionCreate": { "type": "object", "description": "Subscription object", "additionalProperties": false, "properties": { "name": { "type": "string", "minLength": 1, "description": "Subscription name", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 50 }, "description": { "type": "string", "minLength": 1, "description": "Subscription description", "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 255 }, "destination_id": { "type": "string", "minLength": 36, "description": "Destination ID", "pattern": "[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}", "maxLength": 150 }, "topic_id": { "type": "string", "minLength": 36, "description": "Topic ID", "pattern": "[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}", "maxLength": 150 }, "attributes": { "$ref": "#/components/schemas/SubscriptionCreateAttributes" } }, "example": { "attributes": { "signing_enabled": true }, "destination_id": "81ed6419-e7fd-44c6-9d7e-79df74f282d6", "description": "This is test description5", "name": "Webhook sub", "topic_id": "33d2b8d5-8ab8-46c7-97b9-c508afbf0701" }, "required": [ "name", "destination_id", "topic_id" ] }, "SubscriptionList": { "type": "object", "description": "Subscription list object", "additionalProperties": false, "properties": { "total_count": { "description": "Number of subscriptions", "type": "integer", "minimum": 0, "format": "int32" }, "offset": { "type": "integer", "description": "Current offset", "format": "int32" }, "limit": { "type": "integer", "description": "limit to show subscriptions", "format": "int32" }, "subscriptions": { "type": "array", "description": "List of subscriptions", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/SubscriptionListItem" } }, "first": { "$ref": "#/components/schemas/PageHrefResponse" }, "previous": { "$ref": "#/components/schemas/PageHrefResponse" }, "next": { "$ref": "#/components/schemas/PageHrefResponse" } }, "required": [ "total_count", "offset", "limit", "subscriptions" ], "example": { "total_count": 5, "offset": 0, "limit": 10, "subscriptions": [ { "destination_id": "b5cb3f03-ff12-42f3-9fae-37ee27f2a81a", "destination_name": "Developers Email destination", "destination_type": "smtp_ibm", "description": "Developers of EN", "id": "60502ac0-5748-40b1-84b8-938b77f1c8d1", "name": "Test subscription", "topic_id": "33d2b8d5-8ab8-46c7-97b9-c508afbf0701", "topic_name": "Developers topic", "updated_at": "2021-08-18T09:50:32.133355Z" }, { "destination_id": "ec28efee-2236-4c2d-8839-d34f697cfc69", "destination_name": "Admin sms destination", "destination_type": "sms_ibm", "description": "", "id": "87bef75e-f826-4aa9-b64d-91af9be5e12b", "name": "SMS Subscription on new change", "topic_id": "7b23362d-6d48-47ef-847a-c8b291220306", "topic_name": "Event Notification Admin encryption", "updated_at": "2021-08-20T10:08:46.060316Z" }, { "destination_id": "11fe18ba-d0c8-4108-9f07-355e8052a813", "destination_name": "Slack Webhook", "destination_type": "webhook", "description": "Webhook to trigger slack", "id": "d609a018-fbea-428b-82cc-bdfab514ae32", "name": "Developers webhook", "topic_id": "33d2b8d5-8ab8-46c7-97b9-c508afbf0701", "topic_name": "Developers topic", "updated_at": "2021-08-25T13:08:27.544581Z" } ], "first": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/subscriptions?limit=10&offset=0" }, "next": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/subscriptions?limit=10&offset=10" } } }, "SubscriptionListItem": { "type": "object", "description": "Subscription list item", "additionalProperties": false, "properties": { "id": { "description": "ID of the subscription", "type": "string", "minLength": 36, "pattern": "[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}", "maxLength": 150 }, "name": { "description": "Name of the subscription", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 50 }, "description": { "description": "Description of the subscription", "type": "string", "minLength": 0, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 255 }, "destination_id": { "description": "ID of the destination", "type": "string", "minLength": 36, "pattern": "[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}", "maxLength": 150 }, "destination_name": { "description": "Name of the destination", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 150 }, "destination_type": { "description": "The type of destination", "type": "string", "enum": [ "sms_ibm", "smtp_ibm", "webhook", "push_android", "push_ios", "push_chrome", "push_firefox", "slack", "ibmce", "pagerduty", "push_safari", "msteams", "servicenow", "ibmcos", "push_huawei", "smtp_custom", "sms_custom", "event_streams", "app_configuration" ] }, "topic_id": { "description": "ID of the topic", "type": "string", "minLength": 36, "pattern": "[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}", "maxLength": 150 }, "topic_name": { "description": "Name of the topic", "type": "string", "minLength": 1, "pattern": "[a-zA-Z 0-9-_/.?:'\";,+=!#@$%^&*() ]*", "maxLength": 150 }, "updated_at": { "description": "Last updated time of the subscription", "type": "string", "minLength": 1, "maxLength": 255, "format": "date-time" } }, "required": [ "id", "name", "description", "destination_id", "destination_type", "topic_id", "updated_at" ], "example": { "destination_id": "b5cb3f03-ff12-42f3-9fae-37ee27f2a81a", "destination_name": "Developers Email destination", "destination_type": "smtp_ibm", "description": "Developers of EN", "id": "60502ac0-5748-40b1-84b8-938b77f1c8d1", "name": "Test subscription", "topic_id": "33d2b8d5-8ab8-46c7-97b9-c508afbf0701", "topic_name": "Developers topic", "updated_at": "2021-08-18T09:50:32.133355Z" } }, "IntegrationCreate": { "type": "object", "description": "Integration Create", "additionalProperties": false, "properties": { "type": { "description": "The type of Integration", "minLength": 1, "type": "string", "enum": [ "collect_failed_events" ] }, "metadata": { "$ref": "#/components/schemas/IntegrationCreateMetadata" } }, "example": { "type": "collect_failed_events", "metadata": { "endpoint": "https://s3.us-west.cloud-object-storage.test.appdomain.cloud", "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/xxxxxxx6db359a81a1dde8f44bxxxxxx:xxxxxxxx-1d48-xxxx-xxxx-xxxxxxxxxxxx:bucket:cloud-object-storage", "bucket_name": "cloud-object-storage" } }, "required": [ "type", "metadata" ] }, "IntegrationUpdate": { "type": "object", "description": "Integration object", "additionalProperties": false, "properties": { "type": { "type": "string", "description": "Integration type. Allowed values are kms, hs-crypto (deprecated) and collect_failed_events", "minLength": 1, "pattern": "^(kms|hs-crypto|collect_failed_events)$", "maxLength": 50 }, "metadata": { "$ref": "#/components/schemas/IntegrationMetadata" } }, "example": { "type": "kms", "metadata": { "endpoint": "https://private.us-south.kms.cloud.ibm.com", "crn": "crn:v1:staging:public:kms:us-south:a/****:****::", "root_key_id": "cf49847c-bd3e-4fda-853f-2bcf0575a895" } }, "required": [ "type", "metadata" ] }, "IntegrationCreateMetadata": { "type": "object", "description": "Integration Metadata object", "additionalProperties": false, "properties": { "endpoint": { "type": "string", "description": "URL for Cloud Object storage", "minLength": 1, "maxLength": 200, "pattern": ".*" }, "crn": { "type": "string", "description": "CRN of the Cloud Object Storage instance", "minLength": 1, "maxLength": 200, "pattern": ".*" }, "bucket_name": { "type": "string", "description": "Cloud Object Storage bucket name", "minLength": 1, "maxLength": 200, "pattern": ".*" } }, "example": { "endpoint": "https://s3.us-west.cloud-object-storage.test.appdomain.cloud", "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/xxxxxxx6db359a81a1dde8f44bxxxxxx:xxxxxxxx-1d48-xxxx-xxxx-xxxxxxxxxxxx:bucket:cloud-object-storage", "bucket_name": "cloud-object-storage" }, "required": [ "endpoint", "crn", "bucket_name" ] }, "IntegrationMetadata": { "type": "object", "description": "Integration Metadata object", "additionalProperties": false, "properties": { "endpoint": { "type": "string", "description": "KMS url for key management or url for COS bucket", "minLength": 1, "maxLength": 200, "pattern": ".*" }, "crn": { "type": "string", "description": "CRN of the KMS/COS instance", "minLength": 1, "maxLength": 200, "pattern": ".*" }, "root_key_id": { "type": "string", "description": "Root Key ID of KMS", "minLength": 1, "maxLength": 200, "pattern": ".*" }, "bucket_name": { "type": "string", "description": "cloud object storage bucket name", "minLength": 1, "maxLength": 200, "pattern": ".*" } }, "example": { "endpoint": "https://private.us-south.kms.cloud.ibm.com", "crn": "crn:v1:staging:public:kms:us-south:a/****:****::", "root_key_id": "cf49847c-bd3e-4fda-853f-2bcf0575a895", "bucket_name": "cloud-object-storage" }, "required": [ "endpoint", "crn" ] }, "IntegrationCreateResponse": { "type": "object", "description": "Integration create response object", "additionalProperties": false, "properties": { "id": { "description": "ID of the integration", "type": "string", "format": "uuid" }, "type": { "type": "string", "description": "Integration type. Allowed values collect_failed_events" }, "metadata": { "$ref": "#/components/schemas/IntegrationCreateMetadata" }, "created_at": { "description": "Creation time of an integration", "type": "string", "minLength": 1, "maxLength": 255, "format": "date-time" } }, "example": { "id": "bc0cb555-bf6d-444f-b8f3-069199b04a77", "type": "collect_failed_events", "metadata": { "endpoint": "https://s3.us-west.cloud-object-storage.test.appdomain.cloud", "crn": "crn:v1:bluemix:public:cloud-object-storage:global:a/xxxxxxx6db359a81a1dde8f44bxxxxxx:xxxxxxxx-1d48-xxxx-xxxx-xxxxxxxxxxxx:bucket:cloud-object-storage", "bucket_name": "cloud-object-storage" }, "created_at": "2022-08-18T09:50:32.133355Z" }, "required": [ "id", "type", "metadata", "created_at" ] }, "IntegrationGetResponse": { "type": "object", "description": "Integration response object", "additionalProperties": false, "properties": { "id": { "description": "ID of the integration", "type": "string", "format": "uuid" }, "type": { "type": "string", "description": "Integration type. Allowed values are kms, hs-crypto (deprecated) and collect_failed_events" }, "metadata": { "$ref": "#/components/schemas/IntegrationMetadata" }, "created_at": { "description": "Creation time of an integration", "type": "string", "minLength": 1, "maxLength": 255, "format": "date-time" }, "updated_at": { "description": "Last update time of an integration", "type": "string", "minLength": 1, "maxLength": 255, "format": "date-time" } }, "example": { "id": "bc0cb555-bf6d-444f-b8f3-069199b04a77", "type": "kms", "metadata": { "endpoint": "https://private.us-south.kms.cloud.ibm.com", "crn": "crn:v1:staging:public:kms:us-south:a/****:****::", "root_key_id": "cf49847c-bd3e-4fda-853f-2bcf0575a895", "bucket_name": "cloud-object-storage" }, "created_at": "2022-08-18T09:50:32.133355Z", "updated_at": "2022-10-22T09:50:32.133355Z" }, "required": [ "id", "type", "metadata", "created_at", "updated_at" ] }, "IntegrationList": { "type": "object", "description": "all Integrations response object", "additionalProperties": false, "properties": { "total_count": { "description": "Number of integrations", "type": "integer", "minimum": 0, "format": "int32" }, "offset": { "type": "integer", "description": "Current offset", "format": "int32" }, "limit": { "type": "integer", "description": "limit to show integrations", "format": "int32" }, "integrations": { "type": "array", "description": "List of integrations", "minItems": 0, "maxItems": 100, "items": { "$ref": "#/components/schemas/IntegrationListItem" } }, "first": { "$ref": "#/components/schemas/PageHrefResponse" }, "previous": { "$ref": "#/components/schemas/PageHrefResponse" }, "next": { "$ref": "#/components/schemas/PageHrefResponse" } }, "example": { "total_count": 2, "offset": 0, "limit": 10, "integrations": [ { "id": "bc0cb555-bf6d-444f-b8f3-069199b04a77", "type": "kms", "metadata": { "endpoint": "https://private.us-south.kms.cloud.ibm.com", "crn": "crn:v1:staging:public:kms:us-south:a/****:****::", "root_key_id": "cf49847c-bd3e-4fda-853f-2bcf0575a895" }, "created_at": "2021-08-18T09:50:32.133355Z", "updated_at": "2021-08-18T09:50:32.133355Z" }, { "id": "1e77eb50-6dab-4a5e-b145-4c6fb707faa2", "type": "kms", "metadata": { "endpoint": "https://private.us-south.kms.cloud.ibm.com", "crn": "crn:v1:staging:public:kms:us-south:a/****:****::", "root_key_id": "cf49847c-bd3e-4fda-853f-2bcf0575a895" }, "created_at": "2021-08-20T09:50:32.133355Z", "updated_at": "2021-08-20T09:50:32.133355Z" } ], "first": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/integrations?limit=10&offset=0" }, "next": { "href": "https://us-south.event-notifications.cloud.ibm.com/event-notifications/v1/instances/9xxxxx-xxxxx-xxxxx-b3cd-xxxxx/integrations?limit=10&offset=10" } }, "required": [ "total_count", "offset", "limit", "integrations" ] }, "IntegrationListItem": { "type": "object", "description": "all Integrations response object", "additionalProperties": false, "properties": { "id": { "description": "ID of the integration", "type": "string", "format": "uuid" }, "type": { "type": "string", "description": "Integration type. Allowed values are kms, hs-crypto (deprecated) and collect_failed_events" }, "metadata": { "$ref": "#/components/schemas/IntegrationMetadata" }, "created_at": { "description": "Creation time of an integration", "type": "string", "minLength": 1, "maxLength": 255, "format": "date-time" }, "updated_at": { "description": "Update time of an integration", "type": "string", "minLength": 1, "maxLength": 255, "format": "date-time" } }, "example": { "id": "bc0cb555-bf6d-444f-b8f3-069199b04a77", "type": "kms", "metadata": { "endpoint": "https://private.us-south.kms.cloud.ibm.com", "crn": "crn:v1:staging:public:kms:us-south:a/****:****::", "root_key_id": "cf49847c-bd3e-4fda-853f-2bcf0575a895" }, "created_at": "2022-08-18T09:50:32.133355Z", "updated_at": "2022-10-22T09:50:32.133355Z" }, "required": [ "id", "type", "metadata", "created_at", "updated_at" ] }, "PageHrefResponse": { "type": "object", "description": "Response having URL of the page.", "required": [ "href" ], "properties": { "href": { "description": "URL to the page.", "type": "string" } } }, "DestinationUpgradeRequest": { "type": "object", "description": "Request payload for upgrading sandbox destination to production", "additionalProperties": false, "required": [ "domain" ], "properties": { "domain": { "description": "Email Domain", "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 250 } }, "example": { "domain": "example.com" } } }, "securitySchemes": { "Authorization": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } }, "parameters": { "InstanceID": { "name": "instance_id", "description": "Unique identifier for IBM Cloud Event Notifications instance", "in": "path", "required": true, "schema": { "type": "string", "minLength": 32, "maxLength": 32, "pattern": "[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}" } }, "SubScriberDeviceID": { "description": "Device ID of the destination tagsubscription", "in": "query", "name": "device_id", "required": false, "schema": { "type": "string", "minLength": 32, "maxLength": 32, "pattern": "[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}" } }, "UserID": { "description": "UserID of the destination", "in": "query", "name": "user_id", "required": false, "schema": { "type": "string", "minLength": 5, "maxLength": 256, "pattern": "[a-z]" } }, "UsrID": { "description": "UserID", "in": "path", "name": "user_id", "required": true, "schema": { "type": "string", "minLength": 5, "maxLength": 256, "pattern": ".*" } }, "TagName": { "description": "TagName of the subscription", "in": "query", "name": "tag_name", "required": false, "schema": { "type": "string", "minLength": 5, "maxLength": 256, "pattern": "[a-z]" } }, "TemplateID": { "name": "id", "description": "Unique identifier for Template", "in": "path", "required": true, "schema": { "type": "string", "minLength": 32, "pattern": "[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}", "maxLength": 32 } }, "SMTPID": { "name": "id", "description": "Unique identifier for SMTP", "in": "path", "required": true, "schema": { "type": "string", "minLength": 32, "pattern": "[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}", "maxLength": 32 } }, "DestinationID": { "name": "id", "description": "Unique identifier for Destination", "in": "path", "required": true, "schema": { "type": "string", "minLength": 36, "pattern": "^[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}$", "maxLength": 36 } }, "IntegrationID": { "name": "id", "description": "Unique identifier for integration", "in": "path", "required": true, "schema": { "type": "string", "minLength": 36, "pattern": "[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}", "maxLength": 36 } }, "SourceID": { "name": "id", "description": "Unique identifier for Source", "in": "path", "required": true, "schema": { "type": "string", "minLength": 1, "pattern": "[a-zA-Z0-9-:_]*", "maxLength": 100 } }, "TopicID": { "name": "id", "description": "Unique identifier for Topic", "in": "path", "required": true, "schema": { "type": "string", "minLength": 36, "pattern": "[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}", "maxLength": 36 } }, "SubscriptionID": { "name": "id", "description": "Unique identifier for Subscription", "in": "path", "required": true, "schema": { "type": "string", "minLength": 36, "pattern": "[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}", "maxLength": 36 } }, "NID": { "name": "id", "description": " Get Notification Id.", "in": "path", "required": true, "schema": { "type": "string", "minLength": 36, "pattern": "[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}", "maxLength": 36 } }, "IncludeForTopics": { "name": "include", "in": "query", "description": "Include sub topics", "required": false, "schema": { "type": "string", "pattern": "[a-z]", "minLength": 1, "maxLength": 20 } }, "UsernameToClone": { "name": "username_to_clone", "in": "query", "description": "provide name of the user to clone", "required": false, "schema": { "type": "string", "pattern": "^[a-z0-9]{18}\\d{2}$", "minLength": 1, "maxLength": 20 } }, "DestinationType": { "name": "destination_type", "description": "Destination type for which metrics are requested. Supported value: smtp_custom. Required when querying metrics for custom email destinations.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "smtp_custom" ] } }, "SMTPConfigId": { "name": "smtp_config_id", "description": "SMTP configuration ID. Required when querying metrics for SMTP interface destinations.", "in": "query", "required": false, "schema": { "type": "string", "minLength": 36, "pattern": "[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}", "maxLength": 36 } }, "LTE": { "name": "lte", "description": "LTE (less than equal), end timestamp in UTC.", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 28, "pattern": "[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" } }, "GTE": { "name": "gte", "description": "GTE (greater than equal), start timestamp in UTC", "in": "query", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 28, "pattern": "[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" } }, "DestID": { "name": "destination_id", "description": "Unique identifier for Destination", "in": "query", "required": false, "schema": { "type": "string", "minLength": 36, "pattern": "[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}", "maxLength": 36 } }, "SubID": { "name": "subscription_id", "description": "Unique identifier for Subscription", "in": "query", "required": false, "schema": { "type": "string", "minLength": 36, "pattern": "[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}", "maxLength": 36 } }, "SrcID": { "name": "source_id", "description": "Unique identifier for Source", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "pattern": "[a-zA-Z0-9-:_]*", "maxLength": 100 } }, "EmailTo": { "name": "email_to", "description": "Receiver email id.", "in": "query", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 256, "pattern": "[A-Za-z0-9\\._%+\\-]+@[A-Za-z0-9\\.\\-]+\\.[A-Za-z]{2,}" } }, "NotificationID": { "name": "notification_id", "description": "Notification Id.", "in": "query", "required": false, "schema": { "type": "string", "minLength": 36, "pattern": "[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}", "maxLength": 36 } }, "Subject": { "name": "subject", "description": "Email subject.", "in": "query", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 256, "pattern": "[a-zA-Z0-9]" } }, "Offset": { "name": "offset", "description": "offset for paginated results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "format": "int64", "default": 0 } }, "PageLimit": { "name": "limit", "description": "Page limit for paginated results", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 1, "format": "int64", "default": 10, "maximum": 100 } }, "SearchString": { "name": "search", "description": "Search string for filtering results", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 100, "pattern": "[a-zA-Z0-9]" } }, "VerificationType": { "name": "type", "description": "Verification type", "in": "query", "required": true, "schema": { "type": "string", "pattern": "[a-z]", "minLength": 1, "maxLength": 20 } }, "SMTPVerificationType": { "name": "type", "description": "SMTP verification type", "in": "query", "required": true, "schema": { "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 20 } }, "Source": { "name": "source", "description": "Source type", "in": "query", "required": true, "schema": { "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 50 } }, "PredefinedDestinationType": { "name": "type", "description": "Destination type", "in": "query", "required": true, "schema": { "type": "string", "pattern": ".*", "minLength": 1, "maxLength": 50 } } } } }