Create or update environment notification

Create or Update an environments-notification for an org.

PUT /organizations/{org}/environments_notifications

Create or update environment notification

cURL

curl --request PUT \
  --url https://app.kosli.com/api/v2/organizations/{org}/environments_notifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "targets": [
    {}
  ],
  "environments": [
    "<string>"
  ],
  "triggers": [
    "ON_STARTED_ARTIFACT"
  ],
  "type": "env"
}
'

400

{
  "message": "<string>",
  "errors": {}
}

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 · (object | SlackActionTarget · object | WebhookActionTarget · object | EmailActionTarget · object)[] · required

Option 1

SlackActionTarget

WebhookActionTarget

EmailActionTarget

environments · string[] · required

triggers · enum<string>[] · required

Available options: ON_STARTED_ARTIFACT, ON_EXITED_ARTIFACT, ON_SCALED_ARTIFACT, ON_ALLOWED_ARTIFACT, ON_NON_COMPLIANT_ENV, ON_COMPLIANT_ENV

type · string · default: env

Allowed value: "env"

Response

200

Successfully updated environments notification.