Skip to main content

events

Creates, updates, deletes, gets or lists an events resource.

Overview​

Nameevents
TypeResource
Idrailway.observability.events

Fields​

The following fields are returned by SELECT queries:

One row per Event.

NameDatatypeDescription
idstring
environment_idstring
project_idstring
actionstring
activity_payloadobjectMinimal event payload for activity feed list rendering. Avoids returning large deployment payload fields like commit messages.
created_atstring (date-time)
environmentobjectEnvironment object
objectstring
payloadobject
severitystring (CRITICAL, INFO, NOTICE, WARNING)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectproject_idenvironment_id, action, object, service_idGets the events for a project. Backed by the Railway GraphQL query events.

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.

NameDatatypeDescription
project_idstring
actionstringGraphQL input object literal of type EventStringListFilter, for example {field: "value"}.
environment_idstring
objectstringGraphQL input object literal of type EventStringListFilter, for example {field: "value"}.
service_idstringGraphQL input object literal of type EventStringListFilter, for example {field: "value"}.

SELECT examples​

Gets the events for a project. Backed by the Railway GraphQL query events.

SELECT
id,
environment_id,
project_id,
action,
activity_payload,
created_at,
environment,
object,
payload,
severity
FROM railway.observability.events
WHERE project_id = '{{ project_id }}' -- required
AND environment_id = '{{ environment_id }}'
AND action = '{{ action }}'
AND object = '{{ object }}'
AND service_id = '{{ service_id }}'
;