Fetch a Push Notification

import { TwilioClient } from "twilio-comms";
async function main() {
    const client = new TwilioClient({
        accountId: "YOUR_ACCOUNTID_HERE",
        authToken: "YOUR_AUTHTOKEN_HERE",
    });
    await client.pushNotifications.fetch("pushNotificationId");
}
main();

{
  "content": {
    "title": "Limon Eats",
    "body": "Your order is on the way!"
  },
  "createdAt": "2025-05-30T17:24:46Z",
  "from": {
    "fcm": "comms_credential_b554a2dc48d74ff03500c2a582349cad"
  },
  "id": "comms_pushnotification_3de3vbxqx0aghtdy1jgf9qdteh",
  "status": "SENT",
  "to": {
    "provider": "FCM",
    "token": "dQvBnKpXmRtYwLzHjFsEuA:APA91bHNaWc-KdLePfQgShTiUjVk_WlXmYnZoApBqCr-DsEtFuGvHwIxJy_KzLaMbNcOdPeQfRgShTiUjVk-WlXmYnZoApBqCrDsEtFuGvHwIxJy_KzLaMbNcO"
  },
  "updatedAt": "2025-05-30T17:24:49Z",
  "priority": "HIGH",
  "sound": null
}

This operation fetches a single Push Notification using its ID.

Data retention: Records are available for 7 days after creation. Requests for data older than 7 days may return incomplete results.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <account_id:auth_token>.

AuthorizationBasic

Basic authentication of the form Basic <api_key:api_key_secret>.

Path parameters

pushNotificationIdstringRequired

Response

contentobject

The content of the Push Notification.

createdAtstringformat: "date-time"

The date and time when the Push Notification was created, in ISO 8601 format.

fromobject

The credentialId is used for authentication and authorization when sending the push notification through the respective channel.

idstringformat: "^comms_pushnotification_[0-7][a-hjkmnpqrstv-z0-9]{25,34}"

A reference to a PushNotification.

statusenum

The status of a Push Notification resource. The status can be one of the following:

scheduled The Push Notification is scheduled to be sent by Twilio in the future.
queued The Push Notification is queued in Twilio for sending.
sent The Push Notification resource has been sent by Twilio.
failed The Push Notification resource processing failed inside Twilio. Use GET /PushNotifications/Operations/{operationId}/Errors for more details.
canceled The communication resource was canceled via API request.

toobject

The recipient of the Push Notification

updatedAtstringformat: "date-time"

The date and time when the Push Notification was last updated, in ISO 8601 format.

priorityenumDefaults to HIGH

The priority of the Push Notification. A value of "low" reduces the client app battery consumption. A value of "high" sends the notification immediately and can wake up a sleeping device.

soundstring or null

The name of the sound to be played for the push notification.

Errors

400

Bad Request Error

404

Not Found Error

429

Too Many Requests Error

500

Internal Server Error

503

Service Unavailable Error