@ibm-cloud/event-notifications-node-admin-sdk
Advanced tools
IBM Cloud Event Notifications Node.js SDK
Node.js client library to interact with various Event Notifications APIs.
Disclaimer: this SDK is being released initially as a pre-release version. Changes might occur which impact applications that use this SDK.
The IBM Cloud Event Notifications Node.js SDK allows developers to programmatically interact with the Event Notifications service in IBM cloud.
| Service Name | Import Path |
|---|---|
| Event-Notifications | @ibm-cloud/event-notifications-node-admin-sdk/event-notifications/v1 |
npm install @ibm-cloud/event-notifications-node-admin-sdk
For general SDK usage information, please see this link
Initialize the sdk to connect with your Event Notifications service instance.
import { EventNotificationsV1 } from '@ibm-cloud/event-notifications-node-admin-sdk/event-notifications/v1';
import { IamAuthenticator } from '@ibm-cloud/event-notifications-node-admin-sdk/auth';
const authenticator = new IamAuthenticator({
apikey: <apikey>, // Event notifications service instance APIKey
});
const eventNotificationsService = EventNotificationsV1.newInstance({
authenticator,
serviceUrl: "https://" + region + ".event-notifications.cloud.ibm.com/event-notifications"
});
SDK Methods to consume
const params = {
instanceId: <instance-id>, // Event notifications service instance GUID
};
eventNotificationsService
.listSources(params)
.then((res) => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch((err) => {
console.warn(err);
});
const params = {
instanceId: <instance-id>, // Event notifications service instance GUID
id: <source-id>, // Event notifications service instance Source ID
};
eventNotificationsService
.getSource(params)
.then((res) => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch((err) => {
console.warn(err);
});
// Rules
const rulesModel = {
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.
};
// TopicUpdateSourcesItem
const topicUpdateSourcesItemModel = {
id: <source-id>, // Event notifications service instance Source ID
rules: [rulesModel],
};
const params = {
instanceId: <instance-id>, // Event notifications service instance GUID
name: <topic-name>,
description: <topic-description>,
sources: [topicUpdateSourcesItemModel],
};
eventNotificationsService
.createTopic(params)
.then((res) => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch((err) => {
console.warn(err);
});
const params = {
instanceId: <instance-id>,
};
eventNotificationsService
.listTopics(params)
.then((res) => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch((err) => {
console.warn(err);
});
const params = {
instanceId: <instance-id>,
id: <topic-id>,
};
eventNotificationsService
.getTopic(params)
.then((res) => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch((err) => {
console.warn(err);
});
// Rules
const rulesModel = {
enabled: true,
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.
};
// TopicUpdateSourcesItem
const topicUpdateSourcesItemModel = {
id: <source-id>,
rules: [rulesModel],
};
const params = {
instanceId: <instance-id>,
id: <topic-id>,
name: <topic-update-name>,
sources: [topicUpdateSourcesItemModel],
};
eventNotificationsService
.replaceTopic(params)
.then((res) => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch((err) => {
console.warn(err);
});
const params = {
instanceId : <instance-id>,
id : <topic-id>,
}
eventNotificationsService
.deleteTopic(params)
.then(res => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch(err => {
console.warn(err);
});
// DestinationConfigParamsWebhookDestinationConfig
const destinationConfigParamsModel = {
url: <destination-config-url>,
verb: <destination-config-verb>,
custom_headers: { <header-key>: <header-value> },
sensitive_headers: [<header-key>],
};
// DestinationConfig
const destinationConfigModel = {
params: destinationConfigParamsModel,
};
const params = {
instanceId: <instance-id>,
name: <destination-name>,
type: <destination-type>,
description: <destination-description>,
config: destinationConfigModel,
};
eventNotificationsService.createDestination(params)
.then(res => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch(err => {
console.warn(err);
});
const params = {
instanceId : <instance-id>,
}
eventNotificationsService.listDestinations(params)
.then(res => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch(err => {
console.warn(err);
});
const params = {
instanceId : <instance-id>,
id : <destination-id>,
}
eventNotificationsService
.getDestination(params)
.then(res => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch(err => {
console.warn(err);
});
// DestinationConfigParamsWebhookDestinationConfig
const destinationConfigParamsModel = {
url: <destination-config-update-url>,
verb: <destination-config-update-verb>,
custom_headers: { <header-key>: <header-value> },
sensitive_headers: [<header-key>],
};
// DestinationConfig
const destinationConfigModel = {
params: destinationConfigParamsModel,
};
const params = {
instanceId: <instance-id>,
id: <destination-id>,
name: <destination-update-name>,
description: <destination-update-description>,
config: destinationConfigModel,
};
eventNotificationsService.updateDestination(params)
.then(res => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch(err => {
console.warn(err);
});
const params = {
instanceId : <instance-id>,
id : <destination-id>,
}
eventNotificationsService
.deleteDestination(params)
.then(res => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch(err => {
console.warn(err);
});
While Creating Subscription use any of one option from webhook, email or SMS
// SubscriptionCreateAttributesWebhookAttributes
const subscriptionCreateAttributesModel = {
signing_enabled: false,
};
const params = {
instanceId: <instance-id>,
name: <subscription-name>,
destinationId: <destination-id>,
topicId: <topic-id>,
attributes: subscriptionCreateAttributesModel,
description: <subscription-description>,
};
eventNotificationsService
.createSubscription(params)
.then(res => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch(err => {
console.warn(err);
});
const params = {
instanceId : <instance-id>,
}
eventNotificationsService
.listSubscriptions(params)
.then(res => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch(err => {
console.warn(err);
});
const params = {
instanceId : <instance-id>,
id : <subscription-id>,
}
eventNotificationsService.
getSubscription(params)
.then(res => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch(err => {
console.warn(err);
});
const subscriptionUpdateAttributesModel = {
signing_enabled: true,
};
const params = {
instanceId: <instance-id>,
id: <subscription-id>,
name: <subscription-update-name>,
description: <subscription-update-description>,
attributes: subscriptionUpdateAttributesModel,
};
eventNotificationsService
.updateSubscription(params)
.then(res => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch(err => {
console.warn(err);
});
const params = {
instanceId : <instance-id>,
id : <subscription-id>,
}
eventNotificationsService
.deleteSubscription(params)
.then(res => {
console.log(JSON.stringify(res.result, null, 2));
})
.catch(err => {
console.warn(err);
});
Find [event_notifications.env.hide(https://github.com/IBM/event-notifications-node-admin-sdk/blob/main/event_notifications.env.hide) in the repo and rename it to event_notifications.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.If you are having difficulties using this SDK or have a question about the IBM Cloud services, please ask a question at Stack Overflow.
If you encounter an issue with the SDK, you are welcome to submit a bug report. Before that, please search for similar issues. It's possible someone has already encountered this issue.
Find more open source projects on the IBM Github Page
See CONTRIBUTING.
This project is released under the Apache 2.0 license. The license's full text can be found in LICENSE.
FAQs
IBM Cloud Event Notifications Admin Node.js SDK
The npm package @ibm-cloud/event-notifications-node-admin-sdk receives a total of 2 weekly downloads. As such, @ibm-cloud/event-notifications-node-admin-sdk popularity was classified as not popular.
We found that @ibm-cloud/event-notifications-node-admin-sdk demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."