webhooks/environment_terminated

POST https://app.qawolf.com/api/webhooks/environment_terminated

If your build server supports node, use @qawolf/ci-sdk instead of calling this endpoint directly. This gives you type safety and clearer errors and output.

Request

curl -X POST https://app.qawolf.com/api/webhooks/environment_terminated \
  -H "Authorization: Bearer $QAWOLF_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"deploymentUrl": "<DeploymentUrl>", "workspaceId": "<WorkspaceId>"}'

Request headers

Header	Value
`Authorization`	`Bearer <your-api-key>`
`Content-Type`	`application/json`

Request body

Pass one of the following to identify the environment.

Field	Type	Description
`environmentId`	string	ID of the ephemeral environment to terminate.
`environmentAlias`	string	Alias of the ephemeral environment to terminate.
`deploymentUrl`	string	Preview URL used when the environment was created via `deploy_success` with `ephemeral_environment: true`.

You may also pass workspaceId.

Field	Type	Description
`workspaceId`	string	Workspace that owns the environment. Only used alongside `environmentAlias` or `deploymentUrl`, since `environmentId` identifies its own workspace. Ignored by a workspace API key. With an organization or user API key, omitting it looks the alias up in your organization’s first-created workspace. See which workspace a request acts on.

Response

{
  "code": "terminated",
  "environmentId": "cl1f6i0in15676w115vt43vw2"
}

A warning field behaves the same way here as on webhooks/deploy_success — present when the request needed a workspace and didn’t name one, never changing the outcome. An unsuccessful request returns failureCode and failureMessage. A 404 also carries suggestions, listing environments close to the one you named.

Response codes

Code	Description
`200`	Environment terminated successfully.
`400`	None of `environmentId`, `environmentAlias`, or `deploymentUrl` was provided. Returns `failureCode: "missingLookup"`.
`404`	Environment not found. Returns `failureCode: "environmentNotFound"` and `suggestions`.
`409`	Environment is already terminated. Returns `failureCode: "alreadyTerminated"` and the `environmentId`.

Plus the common response codes.

Flow conventions

@qawolf/flows

@qawolf/pom

@qawolf/testkit

@qawolf/emails

@qawolf/cli

Local execution

@qawolf/ci-sdk

Triggers

REST

webhooks/environment_terminated

Request

Request headers

Request body

Response

Response codes

​Request

​Request headers

​Request body

​Response

​Response codes

​Related

Request

Request headers

Request body

Response

Response codes

Related