deployment_triggers

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

Overview

Name	deployment_triggers
Type	Resource
Id	railway.deployments.deployment_triggers

Fields

The following fields are returned by SELECT queries:

list

One row per DeploymentTrigger.

Name	Datatype	Description
id	string
base_environment_override_id	string
environment_id	string
project_id	string
service_id	string
branch	string
check_suites	boolean
provider	string
repository	string
valid_check_suites	integer

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	environment_id, project_id, service_id		All deployment triggers. Backed by the Railway GraphQL query deploymentTriggers.
create	insert	branch, environment_id, project_id, provider, repository, service_id		Creates a deployment trigger. Backed by the Railway GraphQL mutation deploymentTriggerCreate.
update	update	id		Updates a deployment trigger. Backed by the Railway GraphQL mutation deploymentTriggerUpdate.
delete	delete	id		Deletes a deployment trigger. Backed by the Railway GraphQL mutation deploymentTriggerDelete.
deploy	exec	environment_id, project_id, service_id		Deploys all connected triggers for an environment. Backed by the Railway GraphQL mutation environmentTriggersDeploy.

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
environment_id	string
project_id	string
service_id	string
branch	string
id	string
provider	string
repository	string

SELECT examples

list

All deployment triggers. Backed by the Railway GraphQL query deploymentTriggers.

SELECT
id,
base_environment_override_id,
environment_id,
project_id,
service_id,
branch,
check_suites,
provider,
repository,
valid_check_suites
FROM railway.deployments.deployment_triggers
WHERE environment_id = '{{ environment_id }}' -- required
AND project_id = '{{ project_id }}' -- required
AND service_id = '{{ service_id }}' -- required
;

INSERT examples

create

Creates a deployment trigger. Backed by the Railway GraphQL mutation deploymentTriggerCreate.

INSERT INTO railway.deployments.deployment_triggers (
branch,
check_suites,
environment_id,
project_id,
provider,
repository,
root_directory,
service_id
)
SELECT 
'{{ branch }}' /* required */,
{{ check_suites }},
'{{ environment_id }}' /* required */,
'{{ project_id }}' /* required */,
'{{ provider }}' /* required */,
'{{ repository }}' /* required */,
'{{ root_directory }}',
'{{ service_id }}' /* required */
RETURNING
id,
base_environment_override_id,
environment_id,
project_id,
service_id,
branch,
check_suites,
provider,
repository,
valid_check_suites
;

Manifest

# Description fields are for documentation purposes
- name: deployment_triggers
props:
  - name: branch
    value: "{{ branch }}"
  - name: check_suites
    value: {{ check_suites }}
  - name: environment_id
    value: "{{ environment_id }}"
  - name: project_id
    value: "{{ project_id }}"
  - name: provider
    value: "{{ provider }}"
  - name: repository
    value: "{{ repository }}"
  - name: root_directory
    value: "{{ root_directory }}"
  - name: service_id
    value: "{{ service_id }}"

UPDATE examples

update

Updates a deployment trigger. Backed by the Railway GraphQL mutation deploymentTriggerUpdate.

UPDATE railway.deployments.deployment_triggers
SET 
branch = '{{ branch }}',
check_suites = '{{ check_suites }}',
repository = '{{ repository }}',
root_directory = '{{ root_directory }}'
WHERE 
id = '{{ id }}' --required
RETURNING
id,
base_environment_override_id,
environment_id,
project_id,
service_id,
branch,
check_suites,
provider,
repository,
valid_check_suites;

DELETE examples

delete

Deletes a deployment trigger. Backed by the Railway GraphQL mutation deploymentTriggerDelete.

DELETE FROM railway.deployments.deployment_triggers
WHERE 
id = '{{ id }}' --required
;

Lifecycle Methods

deploy

Deploys all connected triggers for an environment. Backed by the Railway GraphQL mutation environmentTriggersDeploy.

EXEC railway.deployments.deployment_triggers.deploy 
@environment_id='{{ environment_id }}', --required
@project_id='{{ project_id }}', --required
@service_id='{{ service_id }}' --required
;