Skip to main content
PUT
Create or update environment notification

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

org
string
required

Body

application/json
name
string
required
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_\.~/]*$
Example:

"production-action"

targets
(SlackActionTarget · object | WebhookActionTarget · object | EmailActionTarget · object | NestedConfigActionTarget · object)[]
required
environments
string[]
required
triggers
enum<string>[]
required

The events that fire this action. Each value is shown in the UI under a different label:

  • ON_STARTED_ARTIFACT (Artifact Start): an artifact starts running in the environment.
  • ON_EXITED_ARTIFACT (Artifact Stop): an artifact stops running.
  • ON_SCALED_ARTIFACT (Artifact changed): a running artifact becomes compliant or non-compliant, or gains new provenance. It does not fire when an artifact starts, so it is not a deployment trigger. The name is historical; scaling events are no longer recorded.
  • ON_ALLOWED_ARTIFACT (Artifact allow-listing): an artifact is added to the allow-list.
  • ON_COMPLIANT_ENV (Environment becomes compliant): the environment as a whole flips to compliant.
  • ON_NON_COMPLIANT_ENV (Environment becomes non-compliant): the environment as a whole flips to non-compliant.
Available options:
ON_STARTED_ARTIFACT,
ON_EXITED_ARTIFACT,
ON_SCALED_ARTIFACT,
ON_ALLOWED_ARTIFACT,
ON_NON_COMPLIANT_ENV,
ON_COMPLIANT_ENV
Example:
type
string
default:env
Allowed value: "env"

Response

Successfully updated environments notification.

The response is of type string.

Last modified on September 16, 2026