CUcustomer
Live Notifications

Get a live notification's status

Look up a live notification's current state, lifecycle timestamps, and the status of its most recent delivery.

get/v1/live_notifications/{instance_id}

Request

  • Base URL
    https://api.customer.io
  • URL
    https://api.customer.io/v1/live_notifications/{instance_id}
  • Auth
    HTTP bearer

Path parameters

instance_idstring required

The activity's instance ID (ULID), returned when you started it.

Response

The activity's current status.

instance_idstring

The activity's instance ID.

notification_typestring

The activity's reverse-DNS type identifier.

platformstring

The device platform—ios or android.

state'active' | 'ended' | 'expired' | 'failed'

The activity's lifecycle state.

failure_reasonstring nullable

Why the activity failed, when state is failed.

started_atinteger

When the activity started (unix timestamp).

ended_atinteger nullable

When the activity ended (unix timestamp).

expires_atinteger nullable

When the activity expires (unix timestamp).

Changes

No recorded changes to this operation across all 30 revisions of this API.