onesignal-java-client

OneSignal

• API version: 5.0.1
  • Build date: 2025-05-13T23:45:41.211Z[Etc/UTC]

A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com

For more information, please visit https://onesignal.com

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>org.openapitools</groupId>
  <artifactId>onesignal-java-client</artifactId>
  <version>5.0.1</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'onesignal-java-client' jar has been published to maven central.
    mavenLocal()       // Needed if the 'onesignal-java-client' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "org.openapitools:onesignal-java-client:5.0.1"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/onesignal-java-client-5.0.1.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import com.onesignal.client.ApiClient;
import com.onesignal.client.ApiException;
import com.onesignal.client.Configuration;
import com.onesignal.client.auth.*;
import com.onesignal.client.models.*;
import com.onesignal.client.api.DefaultApi;

public class Example {
  private static final String appId = "YOUR_APP_ID";
  private static final String appKeyToken = "YOUR_APP_KEY";
  private static final String userKeyToken = "YOUR_USER_TOKEN";

  private static Notification createNotification() {
    Notification notification = new Notification();
    notification.setAppId(appId);
    notification.setIsChrome(true);
    notification.setIsAnyWeb(true);
    notification.setIncludedSegments(Arrays.asList(new String[]{"Subscribed Users"}));
    StringMap contentStringMap = new StringMap();
    contentStringMap.en("Test");
    notification.setContents(contentStringMap);

    return notification;
  }

  public static void main(String[] args) {
    // Setting up the client
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    HttpBearerAuth appKey = (HttpBearerAuth) defaultClient.getAuthentication("app_key");
    appKey.setBearerToken(appKeyToken);
    HttpBearerAuth userKey = (HttpBearerAuth) defaultClient.getAuthentication("user_key");
    userKey.setBearerToken(userKeyToken);
    api = new DefaultApi(defaultClient);

    // Setting up the notification
    Notification notification = createNotification();

    // Sending the request
    CreateNotificationSuccessResponse response = api.createNotification(notification);

    // Checking the result
    System.out.print(response.getId();
  }
}

Documentation for API Endpoints

All URIs are relative to https://api.onesignal.com

Class	Method	HTTP request	Description
DefaultApi	cancelNotification	DELETE /notifications/{notification_id}	Stop a scheduled or currently outgoing notification
DefaultApi	createAlias	PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
DefaultApi	createAliasBySubscription	PATCH /apps/{app_id}/subscriptions/{subscription_id}/user/identity
DefaultApi	createApp	POST /apps	Create an app
DefaultApi	createNotification	POST /notifications	Create notification
DefaultApi	createSegment	POST /apps/{app_id}/segments	Create Segment
DefaultApi	createSubscription	POST /apps/{app_id}/users/by/{alias_label}/{alias_id}/subscriptions
DefaultApi	createUser	POST /apps/{app_id}/users
DefaultApi	deleteAlias	DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity/{alias_label_to_delete}
DefaultApi	deleteSegment	DELETE /apps/{app_id}/segments/{segment_id}	Delete Segment
DefaultApi	deleteSubscription	DELETE /apps/{app_id}/subscriptions/{subscription_id}
DefaultApi	deleteUser	DELETE /apps/{app_id}/users/by/{alias_label}/{alias_id}
DefaultApi	exportEvents	POST /notifications/{notification_id}/export_events?app_id={app_id}	Export CSV of Events
DefaultApi	exportSubscriptions	POST /players/csv_export?app_id={app_id}	Export CSV of Subscriptions
DefaultApi	getAliases	GET /apps/{app_id}/users/by/{alias_label}/{alias_id}/identity
DefaultApi	getAliasesBySubscription	GET /apps/{app_id}/subscriptions/{subscription_id}/user/identity
DefaultApi	getApp	GET /apps/{app_id}	View an app
DefaultApi	getApps	GET /apps	View apps
DefaultApi	getNotification	GET /notifications/{notification_id}	View notification
DefaultApi	getNotificationHistory	POST /notifications/{notification_id}/history	Notification History
DefaultApi	getNotifications	GET /notifications	View notifications
DefaultApi	getOutcomes	GET /apps/{app_id}/outcomes	View Outcomes
DefaultApi	getSegments	GET /apps/{app_id}/segments	Get Segments
DefaultApi	getUser	GET /apps/{app_id}/users/by/{alias_label}/{alias_id}
DefaultApi	transferSubscription	PATCH /apps/{app_id}/subscriptions/{subscription_id}/owner
DefaultApi	unsubscribeEmailWithToken	POST /apps/{app_id}/notifications/{notification_id}/unsubscribe	Unsubscribe with token
DefaultApi	updateApp	PUT /apps/{app_id}	Update an app
DefaultApi	updateLiveActivity	POST /apps/{app_id}/live_activities/{activity_id}/notifications	Update a Live Activity via Push
DefaultApi	updateSubscription	PATCH /apps/{app_id}/subscriptions/{subscription_id}
DefaultApi	updateUser	PATCH /apps/{app_id}/users/by/{alias_label}/{alias_id}

Documentation for Models

• App
• BasicNotification
• BasicNotificationAllOf
• BasicNotificationAllOfAndroidBackgroundLayout
• Button
• CreateNotificationSuccessResponse
• CreateSegmentConflictResponse
• CreateSegmentSuccessResponse
• CreateUserConflictResponse
• CreateUserConflictResponseErrorsInner
• CreateUserConflictResponseErrorsItemsMeta
• DeliveryData
• ExportEventsSuccessResponse
• ExportSubscriptionsRequestBody
• ExportSubscriptionsSuccessResponse
• Filter
• FilterExpression
• GenericError
• GenericSuccessBoolResponse
• GetNotificationHistoryRequestBody
• GetSegmentsSuccessResponse
• LanguageStringMap
• Notification
• NotificationAllOf
• NotificationHistorySuccessResponse
• NotificationSlice
• NotificationTarget
• NotificationWithMeta
• NotificationWithMetaAllOf
• Operator
• OutcomeData
• OutcomesData
• PlatformDeliveryData
• PlatformDeliveryDataEmailAllOf
• PlatformDeliveryDataSmsAllOf
• PropertiesBody
• PropertiesDeltas
• PropertiesObject
• Purchase
• RateLimitError
• Segment
• SegmentData
• SegmentNotificationTarget
• Subscription
• SubscriptionBody
• SubscriptionNotificationTarget
• TransferSubscriptionRequestBody
• UpdateLiveActivityRequest
• UpdateLiveActivitySuccessResponse
• UpdateUserRequest
• User
• UserIdentityBody
• WebButton

Documentation for Authorization

Authentication schemes defined for the API:

rest_api_key

• Type: HTTP basic authentication

user_auth_key

• Type: HTTP basic authentication

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

[email protected]