Send Notification To All API
Broadcast push notifications to all registered devices simultaneously
Send Notification To All API
Broadcast push notifications to your entire user base. Perfect for announcements, maintenance alerts, and company-wide communications.
Mass Broadcast
Reach all users with a single API call.
Full Reach
Every registered device receives the message.
Efficient
Optimized for high-volume delivery.
Endpoint Overview
/graphqlSend a push notification to all registered devices in the system. Uses background processing for efficient delivery to large user bases.
Request Parameters
notificationNotificationInput!RequiredObject containing the notification details.
subjectString!RequiredThe notification title displayed to all users.
contentString!RequiredThe notification body message.
dataJSONAdditional payload data for app processing.
GraphQL Mutation
mutation sendNotificationToAll($notification: NotificationInput!) {
sendNotificationToAll(notification: $notification) {
status
message
totalRecipients
jobId
}
}Variables:
{
"notification": {
"subject": "Scheduled Maintenance",
"content": "Our servers will undergo maintenance tonight from 2-4 AM UTC. You may experience brief disconnections.",
"data": {
"type": "maintenance",
"priority": "high"
}
}
}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_ADMIN_TOKEN" \
-d '{
"query": "mutation sendNotificationToAll($notification: NotificationInput!) { sendNotificationToAll(notification: $notification) { status message totalRecipients jobId } }",
"variables": {
"notification": {
"subject": "Scheduled Maintenance",
"content": "Our servers will undergo maintenance tonight from 2-4 AM UTC."
}
}
}'Response
{
"data": {
"sendNotificationToAll": {
"status": "queued",
"message": "Notification queued for delivery to all devices",
"totalRecipients": 15420,
"jobId": "job_broadcast_abc123"
}
}
}{
"errors": [
{
"message": "Notification subject and content are required",
"path": ["sendNotificationToAll"],
"extensions": {
"code": "INVALID_INPUT"
}
}
],
"data": null
}Use Cases
Maintenance Alerts
Notify all users about scheduled maintenance windows.
New Features
Announce new features and app updates.
Security Notices
Broadcast critical security advisories.
Promotions
Share special offers with all users.
Delivery Process
Request Received
Job Created
Batch Delivery
Completion
Best Practices
Use Sparingly
Reserve broadcasts for truly important messages.
Clear Messaging
Make the purpose immediately clear in title.
Timing Matters
Consider global time zones when broadcasting.
Test First
Send to a test device before full broadcast.
Related Endpoints
Use Responsibly
Broadcasting to all users should be reserved for important announcements. Overuse can lead to notification fatigue and users disabling notifications.
Need Targeted Messaging?
For notifications to specific users or segments, use the Send by Device ID or Send by Token APIs.