Documentation

​
​

Development

User Acquisition

Monetization

Industry

Triggers

Triggers Admin API

Scheduler Admin API

Open Unity Dashboard

Triggers

LiveOps
​
​
Get started
  • Overview
  • Get started
  • Set up triggers example workflow
  • Authentication
Set up events
  • Understand and manage events
  • Schedule events
Define triggers
  • Define triggers
Configure actions
  • Use Cloud Code
  • Use webhooks
Manage and monitor
  • Use the dead letter queue (DLQ)
    • DLQ overview
    • Using the CLI
    • Using the REST API
    • Using the Unity Dashboard
  • Limits
  • Failure handling
Examples and reference
  • Use case samples
  1. Triggers
  3. Manage the dead letter queue

Manage the dead letter queue with the CLI

List, replay, and discard dead letter queue events from the command line using the Unity Gaming Services CLI.
Read time 2 minutes
Last updated 5 months ago
You can use the Unity Gaming Services CLI to interact with the dead letter queue (DLQ). The CLI allows you to list dead letter queue (DLQ) events, fetch a single event by ID, replay events to retry delivery, and discard events from the command line.

Prerequisites

For detailed CLI setup instructions, refer to the Unity Gaming Services CLI Get Started guide.
To follow this guide, you first need to complete the following actions:
  1. Install the UGS CLI.
  2. Configure your Project ID and Environment in the following format:
    ugs config set project-id <your-project-id>

    ugs config set environment-name <your-environment-name>
  3. Configure a Service Account with the required roles for Triggers:
    • Triggers DLQ Viewer (to list and get events).
    • Triggers DLQ Manager (to also replay and discard).
Refer to Get Authenticated.

Using the CLI

For a full reference of all commands and options, refer to the Triggers Command Line documentation.
For examples that use 
<event-id>
, replace 
<event-id>
with the event ID from the list output.
Note
The 
ugs triggers dlq
command is also available as 
ugs tr dlq
.

List DLQ events

List events in the dead letter queue for the current project and environment:
ugs triggers dlq list
You can optionally filter by status or limit the number of results:
ugs triggers dlq list --status pendingugs triggers dlq list --limit 50
The output shows event ID, trigger name, source, status, and time created for each event.

Get a DLQ event

Fetch a single DLQ event by ID and view its payload and metadata:
ugs triggers dlq get <event-id>

Replay DLQ events

Replay queues the event for retry. The CLI returns immediately; a background worker re-publishes the event asynchronously.
Replay a single pending event:
ugs triggers dlq replay <event-id>
Replay all pending events in the project and environment:
ugs triggers dlq replay --all

Discard DLQ events

Discard a single pending event (remove it from the queue without reprocessing):
ugs triggers dlq discard <event-id>
Discard all pending events in the project and environment:
ugs triggers dlq discard --all
Warning
Discarding all events is a destructive operation. Only events in a discardable state (for example Pending) are removed. You can run 
ugs triggers dlq list --status pending
first to see which triggers you can remove.

Additional resources

  • Dead letter queue
  • Failure handling
  • Limits
  • Manage the dead letter queue in the Unity Dashboard
  • Manage the dead letter queue with the REST API
Copyright © 2026 Unity Technologies
LegalPrivacy PolicyCookiesDocumentation Terms of UseDo Not Sell or Share My Personal InformationYour Privacy Choices (Cookie Settings)

"Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S and elsewhere (more info here). Other names or brands are trademarks of their respective owners.

Some pages are machine-translated for convenience, and may contain inaccuracies. In the event of conflicting information, the English version is authoritative.

  • On this page

    • Prerequisites

    • Using the CLI

      • List DLQ events

      • Get a DLQ event

      • Replay DLQ events

      • Discard DLQ events

    • Additional resources

Report a problem with this page