Requirements
General- HTTPS Required: All API requests must use HTTPS with TLS 1.2 or higher, on port
443
. - Network Access: Firewalls or proxies must allow outbound traffic to
https://api.onesignal.com
on port443
. - DNS TTL: Clients must respect OneSignal’s DNS TTL of 300 seconds to avoid stale IP resolution.
- You may see Cloudflare IP addresses in logs.
- These IPs are managed by Cloudflare and may change over time.
- If you maintain a strict firewall and need to allow outbound traffic to OneSignal, use Cloudflare’s official IP ranges:
https://www.cloudflare.com/ips/
We do not recommend whitelisting specific Cloudflare IPs, as they may change without notice.
europe-west4
region (Groningen, Netherlands).
- To allow inbound traffic from OneSignal, consult GCP’s maintained list of IP ranges:
https://www.gstatic.com/ipranges/cloud.json
(You can filter by theeurope-west4
region.)
We support IP Allowlisting with REST API keys.
Platform-specific network requirements
FCM (Google Android and Chrome push)
- Required ports:
5228
,443
,5229
, and5230
- No IP allow-listing needed
- More info: Firebase Cloud Messaging (FCM)
APNs (Apple iOS, iPadOS, Safari push)
- Required ports:
5223
,443
, and2197
- Recommended servers:
- Sandbox:
api.sandbox.push.apple.com:443
- Production:
api.push.apple.com:443
- IP range:
17.0.0.0/8
- Sandbox:
- More info:
Core API capabilities
Send messages
See our Create Message guide to get started. Programmatically send:Push Notifications
Send push notifications to apps and websites.
Send transactional and promotional emails.
SMS
Send SMS or MMS messages globally.
Live Activities
Send Live Activity updates to iOS devices.
Supported features
Below are common supported features for each platform. See our overview docs for each platform’s supported features:Message Personalization
Add dynamic content to personalize messages for each user.
Multi-Language Messaging
Send push notifications in multiple languages.
Throttling
Control push notification delivery speed.
Frequency Capping
Limit the number of push notifications per user.
Data & background notifications
Send data-only notifications for background tasks.
Manage templates
Templates are reusable push, email, and SMS messages that simplify development and improve consistency.Create template
Create a reusable template.
Update template
Update a template.
View templates
View all templates.
Delete template
Delete a template.
Manage users and subscriptions
See our Users and Subscriptions guides for more details.Create user
Create a user with optional aliases and subscriptions.
View user
View user details.
Update user
Update a user.
Delete user
Delete a user.
Manage segments
Segments help group users by filters.You can also target users dynamically using filters without creating persistent segments.
Export data
For analytics breakdowns, see Analytics overview.Export CSV of subscriptions
Export all user and subscription data.
Export CSV of events
Export events like sent, received, and clicked.
View messages
View message details and analytics.
View message
View individual message details.
Manage apps & keys
OneSignal allows you to group platforms (mobile apps, websites) under a single App ID. See Apps, orgs, & accounts.Create an app
Create an app.
Update an app
Update an app.
View single app
View a single app.
View multiple apps
View all apps.
Create API key
Create an API key.
View API keys
View all API keys.
Delete API key
Delete an API key.
Update API key
Update an API key.
Reliability and delivery
Rate limits
All API endpoints are subject to rate limits. Limits vary by endpoint and request type. Refer to the Rate Limits reference for full details.Rate limits are returned via response headers. Be sure to implement exponential backoff retry logic based on
Retry-After
.Retries
If a request fails due to a temporary server error (HTTP 5xx) or a rate limit (HTTP 429), you should retry the request using an exponential backoff strategy. For rate limits, always wait the amount of time specified in theRetry-After
header before retrying.
-
HTTP 429 (Too Many Requests):
- Wait for the duration specified in the Retry-After header before retrying.
- Use the
idempotency_key
to prevent sending duplicate messages when retrying.
-
HTTP 5xx (Server Errors):
- Retry the request using exponential backoff (e.g., start with 60 seconds and increase the wait time after each failure).
- Do not retry HTTP 4xx errors (such as 400, 401, or 403) unless you have fixed the underlying issue in your request, as these indicate a problem with your request rather than a temporary server issue.
-
If you do not get a response from our API within 100 seconds, you can retry the request. We recommend using an
idempotency_key
to prevent sending duplicate messages when retrying.
Idempotent requests
Use theidempotency_key
header to prevent duplicate messages when retrying failed requests.
- Available for: Create Message
- Format: Up to 64 alphanumeric characters
- Duration: Idempotency keys are cached for 24 hours
FAQ
What is the timeout for API responses?
- Default: 100 seconds
- If you’re unsure whether a request completed, use an
idempotency_key
to safely retry.
Do I need to download or renew certificates to call the OneSignal API?
No, you do not need to manually download or renew certificates to call the OneSignal API. Our API uses HTTPS with a publicly trusted TLS certificate managed by Cloudflare. These edge certificates are renewed automatically by Cloudflare and trusted by all major browsers, operating systems, and runtimes. No extra action is needed unless your environment has special trust or pinning rules. Why you might be seeing frequent certificate changes If your network or middleware is configured to pin a specific leaf certificate (the one shown during the TLS handshake), you will see it expire and rotate every few months. This is normal — Cloudflare rotates these certificates for security. Most clients trust the public root and intermediate Certificate Authorities (CAs) instead, which avoids any impact when the leaf cert changes. Recommended approach- Best practice: Trust the root and intermediate CAs in the chain instead of the rotating leaf certificate. This allows certificate rotation without breaking your connection.
- If you must pin a certificate: Pin the public key (SPKI) of the CA or use a backup key set, not the exact leaf certificate.
-showcerts
flag to openssl s_client
and capture all certificates printed.
More information
Cloudflare’s documentation explains how their SSL/TLS certificates work and why they rotate: