Facilitates sending alerts with customizable configurations using simple or DSL styles, supporting asynchronous operations. Suitable for integration into backend systems or applications.
This library is compatible with Java 17 and higher. Suitable uses include Java or Kotlin backends or Android applications.
Add the following dependency to your build.gradle
dependencies {
implementation 'com.apialerts:client:<latest-version>'
}or toml file:
apialerts = { module = "com.apialerts:client", version = "<latest-version>" }Ensure mavenCentral() is added to your repository list
// Custom config can be passed to the client
ApiAlerts.configure(
apiKey = "your-api-key",
debug = true
)You can send alerts using the simple style or DSL style.
Simple Style
ApiAlerts.send(
apiKey = "your-api-key", // Optional, uses the key from ApiAlerts.configure() if not provided
channel = "your-channel", // Optional, uses the default channel if not provided
message = "Your alert message",
tags = listOf("tag1", "tag2"), // Optional tags
link = "https://example.com" // Optional link
)DSL Style
ApiAlerts.send {
apiKey = "your-api-key" // Optional, uses the key from ApiAlerts.configure() if not provided
channel = "your-channel" // Optional, uses the default channel if not provided
message = "Your alert message"
tags = listOf("tag1", "tag2") // Optional tags
link = "https://example.com" // Optional link
}The ApiAlerts.sendAsync methods are also available if you need to wait for a successful execution. However, the send() functions are generally always preferred.
This library is compatible with Java 17 and higher. Suitable uses include Java or Kotlin backends or Android applications.
Add the following dependency to your build.gradle
dependencies {
implementation 'com.apialerts:client:<latest-version>'
}or toml file:
apialerts = { module = "com.apialerts:client", version = "<latest-version>" }Ensure mavenCentral() is added to your repository list
// Custom config can be passed to the client
ApiAlerts.configure(
apiKey = "your-api-key",
debug = true
)You can send alerts using the simple style or DSL style.
Simple Style
ApiAlerts.send(
apiKey = "your-api-key", // Optional, uses the key from ApiAlerts.configure() if not provided
channel = "your-channel", // Optional, uses the default channel if not provided
message = "Your alert message",
tags = listOf("tag1", "tag2"), // Optional tags
link = "https://example.com" // Optional link
)DSL Style
ApiAlerts.send {
apiKey = "your-api-key" // Optional, uses the key from ApiAlerts.configure() if not provided
channel = "your-channel" // Optional, uses the default channel if not provided
message = "Your alert message"
tags = listOf("tag1", "tag2") // Optional tags
link = "https://example.com" // Optional link
}The ApiAlerts.sendAsync methods are also available if you need to wait for a successful execution. However, the send() functions are generally always preferred.