Sign in
Push Notifications

Send push notification (Admin only)

Send push notification to specified users.

This endpoint is typically used by the system internally. In a production environment, you might want to add additional authorization checks to ensure only admin users or system processes can send notifications.

post/push-notifications/send

Request body

user_idsstring[] required

List of user IDs to send notifications to

Example request

{
  "payload": {
    "badge": 1,
    "body": "Your job summary has been generated",
    "data": {
      "redirect_url": "/task/12345",
      "task_id": "12345",
      "type": "summary_ready"
    },
    "sound": "default",
    "title": "Summary Ready"
  },
  "user_ids": [
    "user_2abc123"
  ]
}

Response

Successful Response

success_countinteger required

Number of successful notifications sent

failure_countinteger required

Number of failed notifications

total_tokensinteger required

Total number of tokens processed

failed_tokensstring[]

List of failed tokens

detailsobject nullable

Additional response details

Changes

No recorded changes to this endpoint across all 1 revision of this API.