ibm-eventnotifications 0.4.0

Python server SDK for IBM Cloud Event Notifications service

IBM Cloud Event Notifications Python Admin SDK 0.4.0

Python client library to interact with various IBM Cloud Event Notifications APIs.

Table of Contents

• Overview
• Prerequisites
• Installation
• Initialize SDK
• Using the SDK
• Set Environment
• Questions
• Issues
• Open source @ IBM
• Contributing
• License

Overview

The IBM Cloud Event Notifications Python SDK allows developers to programmatically interact with Event Notifications service in IBM cloud.

Service Name	Module Name	Imported Class Name
Event Notifications Service	ibm_eventnotifications	EventNotificationsV1

Prerequisites

• An IBM Cloud account.
• An Event Notifications Instance
• Python 3.6 or above.

Installation

To install, use pip or easy_install:

pip install --upgrade "ibm_eventnotifications>=0.4.0"

or

easy_install --upgrade "ibm_eventnotifications>=0.4.0"

Initialize SDK

Initialize the sdk to connect with your Event Notifications service instance.

from ibm_eventnotifications.event_notifications_v1 import EventNotificationsV1
from ibm_cloud_sdk_core.authenticators import IAMAuthenticator

 # Create an IAM authenticator.
authenticator = IAMAuthenticator('<iam-api-key>')

# Construct the service client.
event_notifications_service = EventNotificationsV1(authenticator=authenticator)

# Set our custom service URL (optional)
event_notifications_service.set_service_url('https://' + region + '.event-notifications.cloud.ibm.com/event-notifications')

To configure service URL for Private Endpoint

If you enabled service endpoints in your account, you can send API requests over the IBM Cloud private network. In the initialisation, the base endpoint URLs of the IAM(authenticator) & Event Notification(service) should be modified to point to private endpoints.

1. Setting client options programmatically

 # Create an IAM authenticator.
authenticator = IAMAuthenticator('<iam-api-key>', 'https://private.iam.cloud.ibm.com')

# Construct the service client.
event_notifications_service = EventNotificationsV1(authenticator=authenticator)
# To configure service URL for Private Endpoint
event_notifications_service.set_service_url('https://private.' + region + '.event-notifications.cloud.ibm.com/event-notifications')

2. Using external configuration properties

 EVENT_NOTIFICATIONS_AUTH_URL = https://private.iam.cloud.ibm.com/identity/token

• region : Region of the Event Notifications Instance

Using the SDK

SDK Methods to consume

• Source
  • Create Source
  • List Sources
  • Get Source
  • Update Source
  • Delete Source
• Topics
  • Create Topics
  • List Topics
  • Get Topic
  • Update Topics
  • Delete Topics
• Destinations
  • Create Destination
  • List Destinations
  • Get Destination
  • Update Destination
  • Delete Destination
  • Custom Domain_Name_verification
  • Test Destination
• Templates
  • Create Template
  • List Templates
  • Get Template
  • Update Template
  • Delete Template
• Push Destination APIs
  • Create Destination tag subscription
  • List Destination tag subscription
  • Delete Destination device tag subscription
• Subscriptions
  • Create Subscription
  • List Subscriptions
  • Get Subscription
  • Update Subscription
  • Delete Subscription
• Integration
  • Create Integration
  • List Integrations
  • Get Integrations
  • Update Integration
• Send Notifications

Source

Create Source

source_response = event_notifications_service.create_sources(
            <instance-id>, # Event notifications service instance GUID
            name=<source-name>,
            description=<source-description>,
            enabled=False
        ).get_result()

print(json.dumps(source_response, indent=2))

List Sources

source_list = event_notifications_service.list_sources(
    <instance-id>, # Event notifications service instance GUID
  ).get_result()

print(json.dumps(source_list, indent=2))

Get Source

source = event_notifications_service.get_source(
      <instance-id>, # Event notifications service instance GUID
      id=<source-id>,   # Event notifications service instance Source ID
  ).get_result()

print(json.dumps(source, indent=2))

Update Source

source = event_notifications_service.update_source(
            <instance-id>, # Event notifications service instance GUID
            id=<source-id>,   # Event notifications service instance Source ID
            name=<source-name>,
            description=<source-description>,
            enabled=True
        ).get_result()

print(json.dumps(source, indent=2))

Delete Source

response = event_notifications_service.delete_source(
            <instance-id>, # Event notifications service instance GUID
            id=<source-id>,   # Event notifications service instance Source ID
        )

Topics

Create Topic

rules_model = {
    'enabled': False,
    'event_type_filter': '$.notification_event_info.event_type == \'cert_manager\'', #Add your event type filter here.
    'notification_filter': '$.notification.findings[0].severity == \'MODERATE\'', #Add your notification filter here.
}

# Construct a dict representation of a TopicUpdateSourcesItem model
topic_update_sources_item_model = {
    'id': <source_id>,
    'rules': [rules_model],
}

topic_response = event_notifications_service.create_topic(
    <instance_id>,
    name=<topic-name>,
    description=<topic-description>,
    sources=[topic_update_sources_item_model]
)

print(json.dumps(topic_response, indent=2))

List Topics

topic_list = event_notifications_service.list_topics(
    <instance-id>,
).get_result()

print(json.dumps(topic_list, indent=2))

Get Topic

topic = event_notifications_service.get_topic(
      <instance-id>, # Event notifications service instance GUID
      id=<topic-id>, # Event notifications service instance Topic ID
  ).get_result()

print(json.dumps(topic, indent=2))

Update Topic

rules_model = {
    'enabled': True,
    'event_type_filter': '$.notification_event_info.event_type == \'core_cert_manager\'',
    'notification_filter': '$.notification.findings[0].severity == \'SEVERE\'',
}

# Construct a dict representation of a TopicUpdateSourcesItem model
topic_update_sources_item_model = {
    'id': <source-id>,  # Event notifications service instance Source ID
    'rules': [rules_model],
}

description = "Updated Topic for GCM notifications"
name = 'Updated Admin Topic Compliance'
topic = event_notifications_service.replace_topic(
    <instance-id>, # Event notifications service instance GUID
    id=<topic-id>, # Event notifications service instance Topic ID
    name=<topic-update-name> # Event notifications service instance Topic Name
    description=<topic-update-description> # Event notifications service instance Topic description
    sources=[topic_update_sources_item_model]
)

print(json.dumps(topic, indent=2))

rulesModel := &eventnotificationsv1.Rules{
	Enabled:            core.BoolPtr(true),
	EventTypeFilter:    core.StringPtr("$.notification_event_info.event_type == 'core_cert_manager'"), # Add your event type filter here.
	NotificationFilter: core.StringPtr("$.notification.findings[0].severity == 'SEVERE'"), # Add your notification filter here.
}

Delete Topic

response = event_notifications_service.delete_topic(
      <instance-id>,
      id=<topic-id>,
  )

Destinations

Create Destination

destination_config_params_model = {
      'url': '<destination-config-url>',
      'verb': '<destination-config-verb>',
      'custom_headers': {'<header-key>': '<header-value>', },
      'sensitive_headers': ['<header-key>'],
  }

# Construct a dict representation of a DestinationConfig model
destination_config_model = {
    'params': destination_config_params_model,
}

destination = event_notifications_service.create_destination(
    <instance-id>,
    <destination-name>,
    type=<destination-type>,
    description=description,
    config=destination_config_model
).get_result()

print(json.dumps(destination, indent=2))

Among the supported destinations, if you need to create Push Notification destinations, you have the additional option of choosing a destination of production type or pre-production type. Set pre_prod boolean parameter to true to configure destination as pre-production destination else set the value as false. Supported destinations are Android, iOS, Chrome, Firefox, and Safari.

List Destinations

destination_list = event_notifications_service.list_destinations(
    <instance-id>,
).get_result()

print(json.dumps(destination_list, indent=2))

Get Destination

destination = event_notifications_service.get_destination(
      <instance-id>,       # Event notifications service instance GUID
      id=<destination-id>,    # Event notifications service instance Destination ID
  ).get_result()

print(json.dumps(destination, indent=2))

Update Destination

# Construct a dict representation of a DestinationConfigParamsWebhookDestinationConfig model
destination_config_params_model = {
    'url': '<destination-config-update-url>',
    'verb': '<destination-config-update-verb>',
    'sensitive_headers': ['<header-key>'],
}

# Construct a dict representation of a DestinationConfig model
destination_config_model = {
    'params': destination_config_params_model,
}

destination = event_notifications_service.update_destination(
    <instance-id>,      # Event notifications service instance GUID
    id=<destination-id>,   # Event notifications service instance Destination ID
    name=<destination-update-name>,
    description=<destination-update-description>,
    config=destination_config_model
).get_result()

print(json.dumps(destination, indent=2))

Delete Destination

response = event_notifications_service.delete_destination(
      <instance-id>,		# Event notifications service instance GUID
      id=<destination-id>,	# Event notifications service instance Destination ID
  )

Test Destination

This functionality allows you to test a destination. The feature simplifies the process of verifying whether a destination is functioning correctly. Currently, this functionality supports following destinations:

1. Slack
2. PagerDuty
3. ServiceNow
4. Microsoft® Teams
5. IBM Cloud Code Engine
6. IBM Cloud Functions
7. IBM Cloud Object Storage

test_destination_response = event_notifications_service.test_destination(
    <instance-id>,
    id=<destination-id>
)

Once the test is completed, you will be presented with the results. These results will typically include:

• Status: Whether the test is successful or failed
• Response Code: If test fails, then the response code sent from the end destination client is returned
• Response Message: If test fails, then the response message sent from the end destination client is returned

Custom Domain Name Verification

After creation of the custom email destination with your domain name, make sure its validated for the right ownership. This can be done with SPF and DKIM verification.

• Sender Policy Framework (SPF), which is used to authenticate the sender of an email. SPF specifies the mail servers that are allowed to send email for your domain.
• DomainKeys Identified Mail (DKIM), which allows an organization to take responsibility for transmitting a message by signing it. DKIM allows the receiver to check the email that claimed to have come from a specific domain, is authorized by the owner of that domain.

verification_response = event_notifications_service.update_verify_destination(
      <instance-id>,		    # Event notifications service instance GUID
      id=<destination-id>,      # Event notifications service instance Destination ID
      type=<verification-type>, # verification type spf/dkim
  ).get_result()

Templates

Template is a pre-defined layout, that may include content like images, text and dynamic content based on event. Rather than creating a new content from scratch each time, you can use a template as a base and configure them in subscription. supports the following templates:

• Custom Email notification
• Custom Email invitation

Create Template

template_config_model = {
    'body': 'base 64 encoded html content',
    'subject': 'Hi this is invitation for invitation message',
}

create_template_response = event_notifications_service.create_template(
    instance_id=<instance-id>,
    name=<template-name>,
    type=<template-type>,
    params=template_config_model,
    description=<template-description>
).get_result()

List Templates

list_templates_response = event_notifications_service.list_templates(
    instance_id=<instance-id>,
    limit=<limit>,
    offset=<offset>,
    search=<search>
)

templates_list = list_templates_response.get_result()

Get Template

get_template_response = event_notifications_service.get_template(
    instance_id=<instance-id>,
    id=<template_id>
).get_result()

Update Template

template_config_model = {
    'body': 'base 64 encode html content',
    'subject': 'Hi this is invitation for invitation message',
}

replace_template_response = event_notifications_service.replace_template(
    instance_id=<instance-id>,
    id=<template_id>
    name=<template_name>,
    type=<template-type>,
    description=<template-description>,
    params=template_config_model
).get_result()

Delete Template

delete_template_response = event_notifications_service.delete_template(
    instance_id=<instance-id>,
    id=<template_id>
).get_result()

Push Destination APIs

Create Destination tag subscription

tag_subscription = _event_notifications_service.create_tags_subscription(
    <instance-id>,      # Event notifications service instance GUID
    <destination-id>,   # Event notifications service Destintaion ID
    <device_id>,        # Event notifications service Device ID
    <tag_name>          # Event notifications service Tag Name
).get_result()

print(json.dumps(tag_subscription, indent=2))

List Destination tag subscription

subscription = _event_notifications_service.list_tags_subscription(
  <instance-id>,   # Event notifications service instance GUID
  <destination-id> # Event notifications service Destintaion ID
).get_result()

print(json.dumps(subscription, indent=2))

Delete Destination device tag subscription

response = _event_notifications_service.delete_tags_subscription(
  <instance-id>,      # Event notifications service instance GUID
  <destination-id>,   # Event notifications service Destintaion ID
  <device_id>,        # Event notifications service Device ID
  <tag_name>          # Event notifications service Tag Name
).get_result()

print(json.dumps(response, indent=2))

Subscriptions

Create Subscription

#`While Creating Subscription use any of one option from webhook, or email`

subscription_create_attributes_model = {
    'signing_enabled': False,
}

            
subscription = event_notifications_service.create_subscription(
    <instance-id>,	# Event notifications service instance GUID
    name,
    <destination-id>, # Event notifications service instance Destination ID
    <topic-id> # Event notifications service instance Topic ID
    attributes=subscription_create_attributes_model,
    description=<subscription-description>
).get_result()

print(json.dumps(subscription, indent=2))

List Subscriptions

subscription_list = event_notifications_service.list_subscriptions(
     <instance-id>,	# Event notifications service instance GUID
 ).get_result()

print(json.dumps(subscription_list, indent=2))

Get Subscription

 subscription = event_notifications_service.get_subscription(
     <instance-id>,	# Event notifications service instance GUID
     id=<subscription-id>,	# Event notifications service instance Subscription ID
 ).get_result()

print(json.dumps(subscription, indent=2))

Update Subscription

 subscription_update_attributes_model = {
     'signing_enabled': True,
 }

 subscription = event_notifications_service.update_subscription(
     <instance-id>,	# Event notifications service instance GUID
     id=<subscription-id>,	# Event notifications service instance Subscription ID
     name=<subscription-update-name>,
     description=<subscription-update-description>,
     attributes=subscription_update_attributes_model
 ).get_result()

 print(json.dumps(subscription, indent=2))

Delete Subscription

response = event_notifications_service.delete_subscription(
     <instance-id>,	# Event notifications service instance GUID
     id=<subscription-id>,	# Event notifications service instance Subscriptions ID
 )

Integration

Create Integration

integration_metadata = {
    "endpoint": cos_end_point,
    "crn": cos_instance_crn,
    "bucket_name": cos_bucket_name,
}

create_integration_response = self.event_notifications_service.create_integration(
    instance_id,
    type="collect_failed_events",
    metadata=integration_metadata,
)

integration_response = create_integration_response.get_result()

List Integrations

list_integrations_response = event_notifications_service.list_integrations(
    <instance-id>,
    <limit>,
    <offset>,
    <search>,
)

integration_response = list_integrations_response.get_result()

Get Integration

get_integration_response = event_notifications_service.get_integration(
  <instance_id>,
  id=<integration_id>
)

integration_response = get_integration_response.get_result()

Update Integration

For kms/hs-crypto

integration_metadata = {
  'endpoint': '<end-point>',
  'crn': '<crn>',
  'root_key_id': '<root-key-id>'
}

update_integration_response = event_notifications_service.replace_integration(
  <instance_id>,
  type="kms/hs-crypto",
  id=<integration_id>,
  metadata=integration_metadata
)

integration_response = update_integration_response.get_result()

For Cloud Object Storage

integration_metadata = {
  'endpoint': '<end-point>',
  'crn': '<crn>',
  'bucket-name': '<cos-bucket-name>'
}

update_integration_response = event_notifications_service.replace_integration(
  <instance_id>,
  type="collect_failed_events",
  id=<integration_id>,
  metadata=integration_metadata
)

integration_response = update_integration_response.get_result()

Send Notifications

notification_devices_model = {
  'fcm_devices': ['<fcm-device-ids>'],
  'apns_devices': ['<apns-device-ids>'],
  'user_ids': ['<user-ids>'],
  'tags': ['<tag-names>'],
  'platforms': ['<device-platforms>'],
}

notification_apns_body_model = {
    "aps": {
        "alert": "<notification-message>",
        "badge": 5,
    },
}
notification_fcm_body_model = {
    'message': {
        'android': {
            'notification': {
                'title': '<notification-title>', 
                'body': '<notification-message>',
            },
            'data': {
                'name': 'Robert',
                'description': 'notification for the Poker',
            },
        },
    },
}

message_apns_headers = {
    "apns-collapse-id": "<apns-apns-collapse-id-value>",
}

notificationSafariBodymodel = {
    'saf': {
        'alert': 'Game Request',
        'badge': 5,
    },
}

notification_id = "<notification-id>"
notification_severity = "<notification-severity>"
type_value = "<notification-type>"
notifications_source = "<notification-source>"
htmlbody = '"Hi  ,<br/>Certificate expiring in 90 days.<br/><br/>Please login to ' \
           '<a href="https: //cloud.ibm.com/security-compliance/dashboard">' \
           'Security and Complaince dashboard</a> to find more information<br/>"'
mailto = '[\"[e-mail]\", \"[e-mail]\"]'
smsto = '[\"[phone]\", \"[phone]\"]'

notification_create_model = {
    'ibmenseverity': notification_severity,
    'ibmenfcmbody': json.dumps(notification_fcm_body_model),
    'ibmenpushto': json.dumps(notification_devices_model),
    'ibmenapnsbody': json.dumps(notification_apns_body_model),
    'ibmensourceid': source_id,
    'ibmendefaultshort': 'short info',
    'ibmendefaultlong': 'long info',
    'ibmensafaribody': json.dumps(notificationSafariBodymodel),
    'ibmenhtmlbody': htmlbody,
    'ibmensubject': 'Findings on IBM Cloud Security Advisor',
    'ibmenmailto': mailto,
    'ibmensmsto': smsto,
    'id': notification_id,
    'source': notifications_source,
    'type': type_value,
    'specversion': '1.0',
    'time': '2019-01-01T12:00:00.000Z',
}

send_notifications_response = event_notifications_service.send_notifications(
      instance_id,
      body=notification_create_model
    ).get_result()

Send Notifications Variables

• ibmenpushto - Set up the push notifications targets.
  • user_ids (Array of String) - Send notification to the specified userIds.
  • fcm_devices (Array of String) - Send notification to the list of specified Android devices.
  • apns_devices (Array of String) - Send notification to the list of specified iOS devices.
  • chrome_devices (Array of String) - Send notification to the list of specified Chrome devices.
  • firefox_devices (Array of string) - Send notification to the list of specified Firefox devices.
  • tags (Array of string) - Send notification to the devices that have subscribed to any of these tags.
  • platforms (Array of string) - Send notification to the devices of the specified platforms.
    • Pass 'G' for google (Android) devices.
    • Pass 'A' for iOS devices.
    • Pass 'WEB_FIREFOX' for Firefox browser.
    • Pass 'WEB_CHROME' for Chrome browser.
• Event Notifications SendNotificationsOptions - Event Notifications Send Notifications method.
  • instance_id (string) - Unique identifier for IBM Cloud Event Notifications instance.
  • ibmenseverity (string) - Severity for the notifications. Some sources can have the concept of an Event severity. Hence a handy way is provided to specify a severity of the event. example: LOW, HIGH, MEDIUM
  • id* (string) - A unique identifier that identifies each event. source+id must be unique. The backend should be able to uniquely track this id in logs and other records. Send unique ID for each send notification. Same ID can be sent in case of failure of send notification. source+id will be logged in IBM Cloud Logging service. Using this combination we will be able to trace the event movement from one system to another and will aid in debugging and tracing.
  • source* (string) - Source of the notifications. This is the identifier of the event producer. A way to uniquely identify the source of the event. For IBM Cloud services this is the crn of the service instance producing the events. For API sources this can be something the event producer backend can uniquely identify itself with.
  • ibmensourceid* (string) - This is the ID of the source created in EN. This is available in the EN UI in the "Sources" section.
  • type (string) - This describes the type of event. It is of the form : This type is defined by the producer. The event type name has to be prefixed with the reverse DNS names so the event type is uniquely identified. The same event type can be produced by 2 different sources. It is highly recommended to use hyphen - as a separator instead of _.
  • data (string) - The payload for webhook notification. If data is added as part of payload then its mandatory to add datacontenttype.
  • datacontenttype - The notification content type. example: application/json
  • time (string) - Time of the notifications. UTC time stamp when the event occurred. Must be in the RFC 3339 format.
  • ibmenpushto (string) - Targets for the FCM notifications. This contains details about the destination where you want to send push notification. This attribute is mandatory for successful delivery from an Android FCM or APNS destination.
  • ibmenfcmbody (string) - Set payload string specific to Android platform [Refer this FCM official link].
  • ibmenhuaweibody (string) - Set payload string specific to Android platform [Refer this FCM official link].
  • ibmenapnsbody (string) - Set payload string specific to iOS platform [Refer this APNs official doc link].
  • ibmensafaribody (string) - Set payload string specific to safari platform [Refer this Safari official doc link].
  • ibmenapnsheaders (string) - Set headers required for the APNs message [Refer this APNs official link(Table 1 Header fields for a POST request)]
  • ibmenchromebody (string) - Message body for the Chrome notifications. Refer this official documentation for more.
  • ibmenfirefoxbody (string) - Message body for the Firefox notifications. Refer this official documentation for more.
  • ibmenchromeheaders (string) - Headers for the Chrome notifications. Refer this official documentation for more.
  • ibmenfirefoxheaders (string) - Headers for the Firefox notifications. Refer this official documentation for more.
  • ibmendefaultshort* (string) - Default short text for the message.
  • ibmendefaultlong* (string) - Default long text for the message.
  • specversion* (string) - Spec version of the Event Notifications. Default value is 1.0.
  • ibmenhtmlbody* (string) - The html body of notification for email.
  • ibmenmailto* (Array of string) - Array of email ids to which the notification to be sent.
  • ibmensmsto* (Array of string) - Array of SMS numbers to which the notification to be sent.

Note: variable with * represents the mandatory attribute.

Set Environment

Find event_notifications_v1.env.hide in the repo and rename it to event_notifications_v1.env. After that add the values for,

• EVENT_NOTIFICATIONS_URL - Add the Event Notifications service instance Url.
• EVENT_NOTIFICATIONS_APIKEY - Add the Event Notifications service instance apikey.
• EVENT_NOTIFICATIONS_GUID - Add the Event Notifications service instance GUID.

Optional

• EVENT_NOTIFICATIONS_AUTH_URL - Add the IAM url if you are using IBM test cloud.
• EVENT_NOTIFICATIONS_FCM_KEY - Add firebase server key for Android FCM destination.
• EVENT_NOTIFICATIONS_FCM_ID - Add firebase sender Id for Android FCM destination.

Questions

If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question Stack Overflow.

Issues

If you encounter an issue with the project, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible that someone has already reported the problem.

Open source @ IBM

Find more open source projects on the IBM Github Page

Contributing

See CONTRIBUTING.md.

License

This SDK is released under the Apache 2.0 license. The license's full text can be found in LICENSE.