OneSignal API

Development / API Key Intermediate HTTPS
Varies by plan (check documentation)

Overview

OneSignal provides programmatic access to self-serve customer engagement solution for push notifications, email, sms & in-app via REST API. This Development API enables developers to integrate self-serve customer engagement solution for push notifications, email, sms & in-app into applications, dashboards, and automated workflows. Check the official documentation for endpoint details, authentication requirements, and rate limits.

Available Data

email delivery status
message ID
bounce/complaint data
open/click tracking
phone number validation
carrier information

Example Response

JSON Response
{
  "message_id": "msg_abc123def456",
  "status": "delivered",
  "to": "user@example.com",
  "subject": "Welcome!",
  "timestamp": "2025-01-15T10:30:00Z"
}

Implementation Example

Request
const url = "https://documentation.onesignal.com/docs/onesignal-api";
// Replace headers or query params with the values required by this API.
const response = await fetch(url, {
  headers: {
  "X-API-Key": "YOUR_API_KEY"
  }
});
if (!response.ok) throw new Error(`Request failed: ${response.status}`);
const data = await response.json();
console.log(data);

What Can You Build?

Note: These code examples are AI-generated and unverified. Always refer to the official API documentation for accurate usage.

Metadata Score Breakdown

Estimated from metadata — endpoint not independently tested

This score is estimated from observable metadata — HTTPS support, authentication model, declared CORS, and documentation reachability — because the API requires authentication or exposes no publicly testable endpoint. The five-signal breakdown is only shown for live-tested APIs.

Metadata estimate · endpoint not independently tested

Technical Specifications

Auth API Key
HTTPS REQUIRED
CORS UNKNOWN
Category Development
Difficulty Intermediate
Verified: 2026-04-07

Recipes Using OneSignal

Build something with this API. Each recipe includes step-by-step instructions and code outlines.

Similar APIs

View All →