Install Self-Hosted
Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesSelf-HostedAgents & TunnelsYAML

Lighthouse

View as Markdown
  • POST
  • /workspaces
  • /:workspace
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /actions

Creates a new Lighthouse action in the pipeline

Request

REQUIRED SCOPES
EXECUTION_MANAGE
URL PARAMETERS
workspacerequiredstring
The human-readable ID of the workspace

Example: "my-company"

project_namerequiredstring
The human-readable ID of the project

Example: "my-project"

pipeline_idrequiredinteger
The ID of the pipeline

Example: 123

POST PARAMETERS
typerequiredstring enum
The type of the action
Allowed enum:
LIGHTHOUSE
urlread-onlystring
API endpoint to GET this object
html_urlread-onlystring
Web URL to view this object in Buddy.works
after_action_idinteger
The numerical ID of the action, after which this action should be added
namerequiredstring
The name of the action
trigger_timestring enum
Specifies when the action should be executed
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
trigger_conditionsTriggerConditionView[]
The list of trigger conditions to meet so that the action can be triggered
run_nextstring enum
Defines whether the action should run in parallel with the next one
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
run_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE
variablesEnvironmentVariableView[]
The list of variables you can use the action
disabledboolean
When set to true the action is disabled. By default it is set to false
timeoutinteger
The timeout in seconds
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions
retry_countinteger
Number of retries if the action fails
retry_intervalinteger
Delay time between auto retries in seconds
loopstring[]
The list of commands that will be executed in a loop
current_revisionstring
The git revision of the last successful run of the action
permissionsPermissionsView
Access permissions configuration
websiterequiredstring
The address of the site on which the audit should run
devicerequiredstring
The device on which the audit will be run
max_resultsinteger
The maximum number of results to store
performancerequiredinteger
Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set
accessibilityrequiredinteger
Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set
best_practicesrequiredinteger
Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set
seorequiredinteger
Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set
first_contentful_paintnumber
The maximum First Contentful Paint metric threshold
first_meaningful_paintnumber
The maximum First Meaningful Paint metric threshold
speed_indexnumber
The maximum Speed Index metric threshold
estimated_input_latencynumber
The maximum Estimated Input Latency metric threshold
total_blocking_timenumber
The maximum Total Blocking Time metric threshold
max_potential_fidnumber
The maximum Max Potential First Input Delay metric threshold
time_to_first_bytenumber
The maximum Time to First Byte metric threshold
first_cpu_idlenumber
The maximum First CPU Idle metric threshold
bootup_timenumber
The maximum JavaScript bootup time metric threshold
network_server_latencynumber
The maximum network server latency metric threshold
interactivenumber
The maximum Time to Interactive metric threshold

Response

RESPONSE BODY
typestring enum
The type of the action
Allowed enum:
LIGHTHOUSE
urlread-onlystring
API endpoint to GET this object
html_urlread-onlystring
Web URL to view this object in Buddy.works
idinteger
The ID of the action
namestring
The name of the action
current_revisionstring
The git revision of the last successful run of the action
trigger_timestring enum
Specifies when the action should be executed
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
trigger_conditionsTriggerConditionView[]
The list of trigger conditions to meet so that the action can be triggered
run_nextstring enum
Defines whether the action should run in parallel with the next one
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
run_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE
variablesEnvironmentVariableView[]
The list of variables you can use the action
disabledboolean
When set to true the action is disabled. By default it is set to false
timeoutinteger
The timeout in seconds
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions
retry_countinteger
Number of retries if the action fails
retry_intervalinteger
Delay time between auto retries in seconds
last_execution_statusstring enum
The status of the last run of the action
Allowed enum:
INPROGRESS,
ENQUEUED,
TERMINATED,
SUCCESSFUL,
FAILED,
INITIAL,
NOT_EXECUTED,
SKIPPED,
TERMINATING,
WAITING_FOR_APPLY,
WAITING_FOR_VARIABLES,
WAITING_FOR_SETTABLE_VARIABLES,
WAITING_FOR_VT_SESSION
pipelineShortPipelineView
Short representation of a pipeline
permissionsPermissionsView
Access permissions configuration
loopstring[]
The list of commands that will be executed in a loop
websitestring
The address of the site on which the audit should run
devicestring
The device on which the audit will be run
max_resultsinteger
The maximum number of results to store
performanceinteger
Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set
accessibilityinteger
Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set
best_practicesinteger
Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set
seointeger
Values from 0 to 100 are accepted. The action returns an error if the score is below the values that are set
first_contentful_paintnumber
The maximum First Contentful Paint metric threshold
first_meaningful_paintnumber
The maximum First Meaningful Paint metric threshold
speed_indexnumber
The maximum Speed Index metric threshold
estimated_input_latencynumber
The maximum Estimated Input Latency metric threshold
total_blocking_timenumber
The maximum Total Blocking Time metric threshold
max_potential_fidnumber
The maximum Max Potential First Input Delay metric threshold
time_to_first_bytenumber
The maximum Time to First Byte metric threshold
first_cpu_idlenumber
The maximum First CPU Idle metric threshold
bootup_timenumber
The maximum JavaScript bootup time metric threshold
network_server_latencynumber
The maximum network server latency metric threshold
interactivenumber
The maximum Time to Interactive metric threshold

Last modified on Mar 18, 2026

Previous pageEdit actionNext pageGet action

Request example

curl -X POST "https://api.buddy.works/workspaces/:workspace/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Lighthouse",
  "type": "LIGHTHOUSE",
  "trigger_time": "ON_EVERY_EXECUTION",
  "device": "mobile",
  "website": "https://buddy.works",
  "performance": 50,
  "accessibility": 50,
  "best_practices": 50,
  "seo": 50
}'
STATUS
200 OK