notification_deliveries

Creates, updates, deletes, gets or lists a notification_deliveries resource.

Overview

Name	notification_deliveries
Type	Resource
Id	railway.observability.notification_deliveries

Fields

The following fields are returned by SELECT queries:

get

One NotificationDelivery row.

Name	Datatype	Description
id	string
user_id	string
created_at	string (date-time)
notification_instance	object	NotificationInstance object
read_at	string (date-time)
status	string	(FAILED, PENDING, SENT)
type	string	(EMAIL, INAPP, WEBHOOK)
updated_at	string (date-time)

list

One row per NotificationDelivery.

Name	Datatype	Description
id	string
user_id	string
created_at	string (date-time)
notification_instance	object	NotificationInstance object
read_at	string (date-time)
status	string	(FAILED, PENDING, SENT)
type	string	(EMAIL, INAPP, WEBHOOK)
updated_at	string (date-time)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	id		Gets a notification delivery by ID for the authenticated user. Backed by the Railway GraphQL query notificationDelivery.
list	select		environment_id, only_unread, project_id, status, type, workspace_id	Gets notification deliveries for the authenticated user. Backed by the Railway GraphQL query notificationDeliveries.
mark_as_read	exec	delivery_ids		Marks notification deliveries as read. Backed by the Railway GraphQL mutation notificationDeliveriesMarkAsRead.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string
environment_id	string
only_unread	boolean
project_id	string
status	string
type	string
workspace_id	string
delivery_ids	array

SELECT examples

get

Gets a notification delivery by ID for the authenticated user. Backed by the Railway GraphQL query notificationDelivery.

SELECT
id,
user_id,
created_at,
notification_instance,
read_at,
status,
type,
updated_at
FROM railway.observability.notification_deliveries
WHERE id = '{{ id }}' -- required
;

list

Gets notification deliveries for the authenticated user. Backed by the Railway GraphQL query notificationDeliveries.

SELECT
id,
user_id,
created_at,
notification_instance,
read_at,
status,
type,
updated_at
FROM railway.observability.notification_deliveries
WHERE environment_id = '{{ environment_id }}'
AND only_unread = '{{ only_unread }}'
AND project_id = '{{ project_id }}'
AND status = '{{ status }}'
AND type = '{{ type }}'
AND workspace_id = '{{ workspace_id }}'
;

Lifecycle Methods

mark_as_read

Marks notification deliveries as read. Backed by the Railway GraphQL mutation notificationDeliveriesMarkAsRead.

EXEC railway.observability.notification_deliveries.mark_as_read 
@delivery_ids='{{ delivery_ids }}' --required
;