Read notification delivery status

GET

/katara/v1/notifications/{id}/deliveries

const url = 'https://api.katara.com/katara/v1/notifications/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/deliveries';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.katara.com/katara/v1/notifications/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/deliveries \
  --header 'Authorization: Bearer <token>'

Authorizations

sessionBearer
sessionCookie

Parameters

Path Parameters

required

string format: uuid

Header Parameters

X-Katara-Account-ID

string format: uuid

/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/

Optional for reads after sign-in. Use the UUID of the account that loaded the application. A different current cookie account returns account_changed before the handler runs. Session bearer and API key clients do not require this header.

Responses

200

Current notification state.

application/json

object

data

required

Array<object>

object

required

string format: uuid

channel

required

string

Allowed values: in_app email webhook push sms

state

required

string

Allowed values: pending sending accepted delivered failed unknown suppressed intercepted dead_letter

attempts

required

integer

<= 5

next_at

required

string format: date-time

result_code

string

version

required

integer

>= 1

batch_id

Stable delivery ID of the frozen digest. All member histories share its outcome.

string format: uuid

Example

{
  "data": [
    {
      "channel": "in_app",
      "state": "pending"
    }
  ]
}

400

Invalid request.

403

A current human session or permission is required.

404

Item or source access is unavailable.

409

The state version changed; reload before editing.