Skip to navigation

Send push notification asynchronously

Asynchronous Push Notification

Queues a push notification for background processing with retry logic and priority handling.

Features:

  • Background job processing
  • Automatic retries with exponential backoff
  • Priority-based processing
  • Scheduled delivery
  • Job status tracking
  • Memory management

Queue Options:

  • priority: Job priority (0-10, higher = more important)
  • maxRetries: Maximum retry attempts (0-10)
  • scheduledFor: Schedule delivery for future
  • expiresAt: Job expiration time
  • userId: User identifier for tracking
  • correlationId: Request correlation ID
  • metadata: Additional job metadata

Response: Returns immediately with job ID and status “queued”.

Job Status Tracking: Use the job ID to check status via GET /push/async/status/{jobId}

Example Request:

POST /push/async/send
Authorization: Bearer your-jwt-token
Content-Type: application/json
{
"tokens": ["token1", "token2"],
"title": "Hello World",
"body": "This is a test notification",
"data": {
"type": "test",
"id": "123"
},
"priority": "high",
"queueOptions": {
"priority": 8,
"maxRetries": 3,
"userId": "user123",
"correlationId": "req_456"
}
}

Authentication

AuthorizationBearer

JWT token for authentication. Use ‘test-jwt-token’ for development.

Request

This endpoint expects an object.
tokenslist of stringsRequired
titlestringRequired>=1 character
bodystringRequired>=1 character
dataobjectOptional
imageUrlstringOptionalformat: "uri"
clickActionstringOptional
badgedoubleOptional>=0
soundstringOptional
priority"high" or "normal"Optional
timeToLivedoubleOptional0-2419200
queueOptionsobjectOptional

Response

This endpoint returns an object.
successboolean
dataobjectOptional
errorobjectOptional