Skip to content
KataraKatara documentation

List dead-lettered deliveries to recover

GET
/katara/v1/orgs/{org_id}/environments/{environment_id}/notification-recovery/deliveries
curl --request GET \
  --url 'https://api.katara.com/katara/v1/orgs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/environments/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/notification-recovery/deliveries?enrollment_id=2489E9AD-2EE2-8E00-8EC9-32D5F69181C0&enrollment_version=1' \
  --header 'Authorization: Bearer <token>'

Requires a signed-in human session and a current notification recovery operator enrollment of your own for this environment, as reviewing one delivery does; owner and administrator roles do not imply it. The enrollment is checked before anything is read. Each delivery is then checked as its review would be, and one whose recipient may no longer receive the event is left out, so a page can hold fewer entries than the limit while next_cursor is present. Addresses, provider receipts and the enrollment are not included.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
org_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
environment_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000

Query Parameters

Section titled “Query Parameters”
enrollment_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
enrollment_version
required
integer
>= 1 <= 9007199254740991
after
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
limit
integer
>= 1 <= 25

Responses

Section titled “Responses”

200

Section titled “200”

Dead-lettered deliveries in this environment, newest first.

Media typeapplication/json
object
data
required
Array<object>
<= 25 items

A dead-lettered delivery and its event, as its review shows them.

object
event
required
object
id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
producer
required
string
Allowed values: account organization billing provider cortex synapse locus
type
required
string
Allowed values: account.security_changed organization.invitation_received organization.membership_changed billing.balance_low billing.payment_failed billing.statement_ready billing.subscription_activated billing.subscription_payment_failed billing.subscription_cancelled billing.subscription_changed provider.health_attention provider.registration_changed provider.payment_updated cortex.usage_limit synapse.run_completed synapse.run_failed synapse.run_cancelled synapse.connection_required synapse.budget_required synapse.evaluation_ready locus.approval_required locus.action_denied locus.connection_revoked locus.access_review_due synapse.ingestion_ready synapse.ingestion_failed synapse.ingestion_unknown synapse.evaluation_failed synapse.evaluation_unknown synapse.online_evaluation_skipped locus.connection_required organization.key_expiring locus.grant_expiring locus.budget_expiring synapse.repository_approval_expiring
schema_version
required
integer
Allowed value: 1
template_version
required
integer
Allowed value: 1
source_operation_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
org_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
environment_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
mode
required
Allowed values: test live
resource_type
required
string
Allowed values: account invitation membership billing provider usage run evaluation approval action connection access_review grant budget key repository_approval
resource_id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
occurred_at
required
string format: date-time
/Z$/
delivery
required
object
id
required
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
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
/Z$/
result_code
string
/^[a-z_]{1,64}$/
version
required
integer
>= 1 <= 9007199254740990
batch_id
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
next_cursor
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
Example
{
  "data": [
    {
      "event": {
        "producer": "account",
        "type": "account.security_changed",
        "schema_version": 1,
        "template_version": 1,
        "mode": "test",
        "resource_type": "account"
      },
      "delivery": {
        "channel": "in_app",
        "state": "pending"
      }
    }
  ]
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store

default

Section titled “default”

Refused or unavailable listing.

Media typeapplication/json
object
error
required
object
message
required
string
>= 1 characters <= 500 characters
type
required
string
>= 1 characters <= 100 characters
code
required

Stable; branch on it. Any operation can answer invalid_request, with param naming the refused field when there is one; human_session_required, when an API key, service account or workload calls an operation only a signed-in person may perform; reauthentication_required, when a person’s sign-in is too old for the operation; permission_denied; route_not_found and method_not_allowed, when no operation matches the path or method; and feature_unavailable, when the operation’s service is not enabled on this deployment.

string
>= 1 characters <= 100 characters
param
required

The request field a refusal is about, such as the agent_id or run_id query parameter; null when the refusal is not about one field.

string | null
request_id
required
string
>= 1 characters <= 100 characters
upstream_status
required
integer | null
action
Allowed values: sign_in reauthenticate request_access review fund retry reconcile refresh support
operation_id
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
snapshot_ref
string format: uuid
/^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/
Allowed value: 00000000-0000-0000-0000-000000000000
Example
{
  "error": {
    "action": "sign_in"
  }
}