README.md

Subscribers.Notifications

Overview

Available Operations

• list - Retrieve subscriber notifications
• delete - Delete a notification
• completeAction - Complete a notification action
• revertAction - Revert a notification action
• archive - Archive a notification
• markAsRead - Mark a notification as read
• snooze - Snooze a notification
• unarchive - Unarchive a notification
• markAsUnread - Mark a notification as unread
• unsnooze - Unsnooze a notification
• archiveAll - Archive all notifications
• count - Retrieve subscriber notifications count
• deleteAll - Delete all notifications
• markAllAsRead - Mark all notifications as read
• archiveAllRead - Archive all read notifications
• markAsSeen - Mark notifications as seen
• getUnseenCount - Retrieve unseen notifications count ⚠️ Deprecated

list

Retrieve in-app (inbox) notifications for a subscriber by its unique key identifier subscriberId. Supports filtering by tags, read/archived/snoozed/seen state, data attributes, severity, date range, and context keys.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.SubscribersControllerGetSubscriberNotificationsRequest;
import co.novu.models.operations.SubscribersControllerGetSubscriberNotificationsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerGetSubscriberNotificationsRequest req = SubscribersControllerGetSubscriberNotificationsRequest.builder()
                .subscriberId("<id>")
                .offset(0d)
                .createdGte(1704067200000d)
                .createdLte(1735689599999d)
                .build();

        SubscribersControllerGetSubscriberNotificationsResponse res = sdk.subscribers().notifications().list()
                .request(req)
                .call();

        if (res.getSubscriberNotificationsResponseDto().isPresent()) {
            System.out.println(res.getSubscriberNotificationsResponseDto().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	SubscribersControllerGetSubscriberNotificationsRequest	✔️	The request object to use for the request.

Response

SubscribersControllerGetSubscriberNotificationsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

delete

Delete a specific in-app (inbox) notification permanently by its unique identifier notificationId.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.SubscribersControllerDeleteNotificationResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerDeleteNotificationResponse res = sdk.subscribers().notifications().delete()
                .subscriberId("<id>")
                .notificationId("<id>")
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
subscriberId	String	✔️	The identifier of the subscriber
notificationId	String	✔️	The identifier of the notification
contextKeys	List<String>	➖	Context keys for filtering
idempotencyKey	Optional<String>	➖	A header for idempotency purposes

Response

SubscribersControllerDeleteNotificationResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

completeAction

Mark a single in-app (inbox) notification's action (primary or secondary) as completed by its unique identifier notificationId and action type actionType.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.*;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerCompleteNotificationActionRequest req = SubscribersControllerCompleteNotificationActionRequest.builder()
                .subscriberId("<id>")
                .notificationId("<id>")
                .actionType(SubscribersControllerCompleteNotificationActionActionType.SECONDARY)
                .build();

        SubscribersControllerCompleteNotificationActionResponse res = sdk.subscribers().notifications().completeAction()
                .request(req)
                .call();

        if (res.inboxNotificationDto().isPresent()) {
            System.out.println(res.inboxNotificationDto().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	SubscribersControllerCompleteNotificationActionRequest	✔️	The request object to use for the request.

Response

SubscribersControllerCompleteNotificationActionResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

revertAction

Revert a single in-app (inbox) notification's action (primary or secondary) to pending state by its unique identifier notificationId and action type actionType.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.*;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerRevertNotificationActionRequest req = SubscribersControllerRevertNotificationActionRequest.builder()
                .subscriberId("<id>")
                .notificationId("<id>")
                .actionType(SubscribersControllerRevertNotificationActionActionType.PRIMARY)
                .build();

        SubscribersControllerRevertNotificationActionResponse res = sdk.subscribers().notifications().revertAction()
                .request(req)
                .call();

        if (res.inboxNotificationDto().isPresent()) {
            System.out.println(res.inboxNotificationDto().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	SubscribersControllerRevertNotificationActionRequest	✔️	The request object to use for the request.

Response

SubscribersControllerRevertNotificationActionResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

archive

Archive a specific in-app (inbox) notification by its unique identifier notificationId.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.SubscribersControllerArchiveNotificationResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerArchiveNotificationResponse res = sdk.subscribers().notifications().archive()
                .subscriberId("<id>")
                .notificationId("<id>")
                .call();

        if (res.inboxNotificationDto().isPresent()) {
            System.out.println(res.inboxNotificationDto().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
subscriberId	String	✔️	The identifier of the subscriber
notificationId	String	✔️	The identifier of the notification
contextKeys	List<String>	➖	Context keys for filtering
idempotencyKey	Optional<String>	➖	A header for idempotency purposes

Response

SubscribersControllerArchiveNotificationResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

markAsRead

Mark a specific in-app (inbox) notification as read by its unique identifier notificationId.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.SubscribersControllerMarkNotificationAsReadResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerMarkNotificationAsReadResponse res = sdk.subscribers().notifications().markAsRead()
                .subscriberId("<id>")
                .notificationId("<id>")
                .call();

        if (res.inboxNotificationDto().isPresent()) {
            System.out.println(res.inboxNotificationDto().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
subscriberId	String	✔️	The identifier of the subscriber
notificationId	String	✔️	The identifier of the notification
contextKeys	List<String>	➖	Context keys for filtering
idempotencyKey	Optional<String>	➖	A header for idempotency purposes

Response

SubscribersControllerMarkNotificationAsReadResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

snooze

Snooze a specific in-app (inbox) notification by its unique identifier notificationId until a specified time.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.components.SnoozeSubscriberNotificationDto;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.SubscribersControllerSnoozeNotificationRequest;
import co.novu.models.operations.SubscribersControllerSnoozeNotificationResponse;
import java.lang.Exception;
import java.time.OffsetDateTime;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerSnoozeNotificationRequest req = SubscribersControllerSnoozeNotificationRequest.builder()
                .subscriberId("<id>")
                .notificationId("<id>")
                .body(SnoozeSubscriberNotificationDto.builder()
                    .snoozeUntil(OffsetDateTime.parse("2026-03-01T10:00:00Z"))
                    .build())
                .build();

        SubscribersControllerSnoozeNotificationResponse res = sdk.subscribers().notifications().snooze()
                .request(req)
                .call();

        if (res.inboxNotificationDto().isPresent()) {
            System.out.println(res.inboxNotificationDto().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	SubscribersControllerSnoozeNotificationRequest	✔️	The request object to use for the request.

Response

SubscribersControllerSnoozeNotificationResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

unarchive

Unarchive a specific in-app (inbox) notification by its unique identifier notificationId.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.SubscribersControllerUnarchiveNotificationResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerUnarchiveNotificationResponse res = sdk.subscribers().notifications().unarchive()
                .subscriberId("<id>")
                .notificationId("<id>")
                .call();

        if (res.inboxNotificationDto().isPresent()) {
            System.out.println(res.inboxNotificationDto().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
subscriberId	String	✔️	The identifier of the subscriber
notificationId	String	✔️	The identifier of the notification
contextKeys	List<String>	➖	Context keys for filtering
idempotencyKey	Optional<String>	➖	A header for idempotency purposes

Response

SubscribersControllerUnarchiveNotificationResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

markAsUnread

Mark a specific in-app (inbox) notification as unread by its unique identifier notificationId.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.SubscribersControllerMarkNotificationAsUnreadResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerMarkNotificationAsUnreadResponse res = sdk.subscribers().notifications().markAsUnread()
                .subscriberId("<id>")
                .notificationId("<id>")
                .call();

        if (res.inboxNotificationDto().isPresent()) {
            System.out.println(res.inboxNotificationDto().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
subscriberId	String	✔️	The identifier of the subscriber
notificationId	String	✔️	The identifier of the notification
contextKeys	List<String>	➖	Context keys for filtering
idempotencyKey	Optional<String>	➖	A header for idempotency purposes

Response

SubscribersControllerMarkNotificationAsUnreadResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

unsnooze

Unsnooze a specific in-app (inbox) notification by its unique identifier notificationId.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.SubscribersControllerUnsnoozeNotificationResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerUnsnoozeNotificationResponse res = sdk.subscribers().notifications().unsnooze()
                .subscriberId("<id>")
                .notificationId("<id>")
                .call();

        if (res.inboxNotificationDto().isPresent()) {
            System.out.println(res.inboxNotificationDto().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
subscriberId	String	✔️	The identifier of the subscriber
notificationId	String	✔️	The identifier of the notification
contextKeys	List<String>	➖	Context keys for filtering
idempotencyKey	Optional<String>	➖	A header for idempotency purposes

Response

SubscribersControllerUnsnoozeNotificationResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

archiveAll

Archive all in-app (inbox) notifications matching the specified filters. Supports context-based filtering.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.components.UpdateAllSubscriberNotificationsDto;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.SubscribersControllerArchiveAllNotificationsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerArchiveAllNotificationsResponse res = sdk.subscribers().notifications().archiveAll()
                .subscriberId("<id>")
                .body(UpdateAllSubscriberNotificationsDto.builder()
                    .build())
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
subscriberId	String	✔️	The identifier of the subscriber
idempotencyKey	Optional<String>	➖	A header for idempotency purposes
body	UpdateAllSubscriberNotificationsDto	✔️	N/A

Response

SubscribersControllerArchiveAllNotificationsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

count

Retrieve count of in-app (inbox) notifications for a subscriber by its unique key identifier subscriberId. Supports multiple filters to count in-app (inbox) notifications by different criteria, including context keys.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.SubscribersControllerGetSubscriberNotificationsCountResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerGetSubscriberNotificationsCountResponse res = sdk.subscribers().notifications().count()
                .subscriberId("<id>")
                .filters("[{\"read\":false,\"archived\":false},{\"tags\":[\"important\"]},{\"tags\":{\"and\":[{\"or\":[\"a\",\"b\"]},{\"or\":[\"c\"]}]}}]")
                .call();

        if (res.getSubscriberNotificationsCountResponseDtos().isPresent()) {
            System.out.println(res.getSubscriberNotificationsCountResponseDtos().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description	Example
subscriberId	String	✔️	The identifier of the subscriber
filters	String	✔️	Array of filter objects (max 30) to count notifications by different criteria	[{"read":false,"archived":false},{"tags":["important"]},{"tags":{"and":[{"or":["a","b"]},{"or":["c"]}]}}]
idempotencyKey	Optional<String>	➖	A header for idempotency purposes

Response

SubscribersControllerGetSubscriberNotificationsCountResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

deleteAll

Permanently delete all in-app (inbox) notifications matching the specified filters. Supports context-based filtering.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.components.UpdateAllSubscriberNotificationsDto;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.SubscribersControllerDeleteAllNotificationsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerDeleteAllNotificationsResponse res = sdk.subscribers().notifications().deleteAll()
                .subscriberId("<id>")
                .body(UpdateAllSubscriberNotificationsDto.builder()
                    .build())
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
subscriberId	String	✔️	The identifier of the subscriber
idempotencyKey	Optional<String>	➖	A header for idempotency purposes
body	UpdateAllSubscriberNotificationsDto	✔️	N/A

Response

SubscribersControllerDeleteAllNotificationsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

markAllAsRead

Mark all in-app (inbox) notifications matching the specified filters as read. Supports context-based filtering.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.components.UpdateAllSubscriberNotificationsDto;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.SubscribersControllerMarkAllNotificationsAsReadResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerMarkAllNotificationsAsReadResponse res = sdk.subscribers().notifications().markAllAsRead()
                .subscriberId("<id>")
                .body(UpdateAllSubscriberNotificationsDto.builder()
                    .build())
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
subscriberId	String	✔️	The identifier of the subscriber
idempotencyKey	Optional<String>	➖	A header for idempotency purposes
body	UpdateAllSubscriberNotificationsDto	✔️	N/A

Response

SubscribersControllerMarkAllNotificationsAsReadResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

archiveAllRead

Archive all read in-app (inbox) notifications matching the specified filters. Supports context-based filtering.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.components.UpdateAllSubscriberNotificationsDto;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.SubscribersControllerArchiveAllReadNotificationsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerArchiveAllReadNotificationsResponse res = sdk.subscribers().notifications().archiveAllRead()
                .subscriberId("<id>")
                .body(UpdateAllSubscriberNotificationsDto.builder()
                    .build())
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
subscriberId	String	✔️	The identifier of the subscriber
idempotencyKey	Optional<String>	➖	A header for idempotency purposes
body	UpdateAllSubscriberNotificationsDto	✔️	N/A

Response

SubscribersControllerArchiveAllReadNotificationsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

markAsSeen

Mark specific and multiple in-app (inbox) notifications as seen. Supports context-based filtering.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.components.MarkSubscriberNotificationsAsSeenDto;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.SubscribersControllerMarkNotificationsAsSeenResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersControllerMarkNotificationsAsSeenResponse res = sdk.subscribers().notifications().markAsSeen()
                .subscriberId("<id>")
                .body(MarkSubscriberNotificationsAsSeenDto.builder()
                    .build())
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
subscriberId	String	✔️	The identifier of the subscriber
idempotencyKey	Optional<String>	➖	A header for idempotency purposes
body	MarkSubscriberNotificationsAsSeenDto	✔️	N/A

Response

SubscribersControllerMarkNotificationsAsSeenResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*

getUnseenCount

This API is deprecated, use v2 API instead. Retrieve unseen in-app notifications count for a subscriber by its unique key identifier subscriberId.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

package hello.world;

import co.novu.Novu;
import co.novu.models.errors.ErrorDto;
import co.novu.models.errors.ValidationErrorDto;
import co.novu.models.operations.SubscribersV1ControllerGetUnseenCountResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ErrorDto, ValidationErrorDto, Exception {

        Novu sdk = Novu.builder()
                .secretKey("YOUR_SECRET_KEY_HERE")
            .build();

        SubscribersV1ControllerGetUnseenCountResponse res = sdk.subscribers().notifications().getUnseenCount()
                .subscriberId("<id>")
                .seen(false)
                .limit(100d)
                .call();

        if (res.unseenCountResponse().isPresent()) {
            System.out.println(res.unseenCountResponse().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
subscriberId	String	✔️	N/A
seen	Optional<Boolean>	➖	Indicates whether to count seen notifications.
limit	Optional<Double>	➖	The maximum number of notifications to return.
idempotencyKey	Optional<String>	➖	A header for idempotency purposes

Response

SubscribersV1ControllerGetUnseenCountResponse

Errors

Error Type	Status Code	Content Type
models/errors/ErrorDto	414	application/json
models/errors/ErrorDto	400, 401, 403, 404, 405, 409, 413, 415	application/json
models/errors/ValidationErrorDto	422	application/json
models/errors/ErrorDto	500	application/json
models/errors/APIException	4XX, 5XX	*/*