Rust SDK

Setup & Initialization

1. Add Dependencies:

cargo add dotenv   # Manage environment variables
cargo add reqwest   # HTTP client for making requests
cargo add tokio --features full  # Required for Async runtime
cargo add serde --features derive # JSON conversion

2. Configure Cargo.toml:

   Enable the JSON feature for reqwest in your Cargo.toml file:

reqwest = { version = "0.12.15", features = ["json"] }

3. Set Up Environment Variables:

Add your credentials to your .env file in your project root:

CLIENT_ID=your_client_id
CLIENT_SECRET=your_client_secret

4. Initialize and Send Notification:

use reqwest::Client;
use serde::Serialize;
use std::env;
use dotenv::dotenv;

#[derive(Serialize)]
struct NotificationPayload<'a> {
    #[serde(rename = "type")]
    notification_type: &'a str,
    to: User,
    #[serde(rename = "parameters")]
    parameters: Parameters<'a>,
}

#[derive(Serialize)]
struct User {
    id: String,
    email: String,
    number: String,
}

#[derive(Serialize)]
struct Parameters<'a> {
    item: &'a str,
    address: &'a str,
    orderId: &'a str,
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Initialize environment variables
    dotenv().ok();
    let client_id = env::var("CLIENT_ID").expect("CLIENT_ID not set in .env file");
    let client_secret = env::var("CLIENT_SECRET").expect("CLIENT_SECRET not set in .env file");

    // Create HTTP client
    let client = Client::new();

    // Prepare notification payload
    let payload = NotificationPayload {
        notification_type: "order_tracking",
        to: User {
            id: "spongebob.squarepants".to_string(),
            email: "spongebob@squarepants.com".to_string(),
            number: "+15005550006".to_string()
        },
        parameters: Parameters {
            item: "Krabby Patty Burger",
            address: "124 Conch Street",
            orderId: "1234567890",
        },
    };

    // Send notification
    let response = client
        .post("https://api.notificationapi.com/{client_id}/sender")
        .basic_auth(client_id, Some(client_secret))
        .json(&payload)
        .send()
        .await?;

    // Check the response status
    if response.status().is_success() {
        println!("Notification sent successfully!");
    } else {
        println!("Failed to send notification: {:?}", response.text().await?);
    }

    Ok(())
}

* required

Region specific example:

let response = client
    .post("https://api.eu.notificationapi.com/{client_id}/sender")
    .basic_auth(client_id, Some(client_secret))
    .json(&payload)
    .send()
    .await?;

Send

Used to send a notification to the specified user.

Pass content directly without templates

You can ignore the templates and pass the content directly through the API by specifying channel content objects on the request.

use reqwest::Client;
use serde::Serialize;
use std::env;
use dotenv::dotenv;

#[derive(Serialize)]
struct NotificationPayload<'a> {
    #[serde(rename = "type")]
    notification_type: &'a str,
    to: User,
    #[serde(rename = "parameters")]
    parameters: Parameters<'a>,
}

#[derive(Serialize)]
struct User {
    id: String,
    email: String,
    number: String,
}

#[derive(Serialize)]
struct Parameters<'a> {
    item: &'a str,
    address: &'a str,
    orderId: &'a str,
}

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    // Initialize environment variables
    dotenv().ok();
    let client_id = env::var("CLIENT_ID").expect("CLIENT_ID not set in .env file");
    let client_secret = env::var("CLIENT_SECRET").expect("CLIENT_SECRET not set in .env file");

    // Create HTTP client
    let client = Client::new();

    // Prepare notification payload
    let payload = NotificationPayload {
        notification_type: "order_tracking",
        to: User {
            id: "spongebob.squarepants".to_string(),
            email: "spongebob@squarepants.com".to_string(),
            number: "+15005550006".to_string()
        },
        parameters: Parameters {
            item: "Krabby Patty Burger",
            address: "124 Conch Street",
            orderId: "1234567890",
        },
    };

    // Send notification
    let response = client
        .post("https://api.notificationapi.com/{client_id}/sender")
        .basic_auth(client_id, Some(client_secret))
        .json(&payload)
        .send()
        .await?;

    // Check the response status
    if response.status().is_success() {
        println!("Notification sent successfully!");
    } else {
        println!("Failed to send notification: {:?}", response.text().await?);
    }

    Ok(())
}

Parameters

The send() method accepts an object with the following fields:

Options Object

Size Limitation

When using parameters (merge tags) in the body of your notifications, it is recommended that the size of the combined parameters not exceed 150 KB. Exceeding this limit may result in delivery failure, or an API error.