Customer.io
v1.0.0
OpenAPI 3.1.0

Get a live notification's status

US region

Client Libraries
Shell Curl

Get a live notification's status

​

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

Path Parameters
  • instance_id
    Type: string
    required

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

Responses
  • application/json
  • 400

    instance_id isn't a valid ULID.

  • 404

    The activity wasn't found—a recently started one may not be processed yet—or live notifications aren't enabled for this workspace.

Request Example for get/v1/live_notifications/{instance_id}
curl 'https://api.customer.io/v1/live_notifications/{instance_id}' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "instance_id": "string",
  "notification_type": "string",
  "platform": "string",
  "state": "active",
  "failure_reason": "string",
  "started_at": 1,
  "ended_at": 1,
  "expires_at": 1,
  "last_delivery": {
    "id": "string",
    "operation": "start",
    "status": "queued",
    "source": "string",
    "created_at": 1
  }
}

The activity's current status.