octoperf-notifications

Workspace notifications — channel + events + filters playbook

Manage a workspace's load-test notifications — OctoPerf's runtime alerting layer. A notification fires a channel (email, Slack, Teams, Google Chat, Webex, HTTP webhook, or JIRA) when a performance test run reaches a chosen event (started / ended / passed / failed / error), optionally narrowed by filters. Their only job is to tell people about test-run outcomes (JIRA additionally comments on / transitions board issues), so they belong to the runtime side of OctoPerf: they pair with run_scenario and schedule_scenario_*, and a scenario surfaces the notifications that will fire for its runs (list_notifications_matching_scenario). Read this before creating or updating one.

Mental model

A notification = channel + events (>=1) + filters (optional).

• Channel — where the message goes. One typed create tool per channel: create_email_notification, create_slack_notification, create_teams_notification, create_google_chat_notification, create_webex_notification, create_http_notification, create_jira_notification (multi-step — see Workflow 4).
• Events (eventIds, at least one): TEST_STARTED, TEST_ENDED, TEST_PASSED, TEST_FAILED, TEST_ERROR.
• Filters (optional) restrict which tests fire it. Omit → fires for every test in the workspace.

Secrets are write-only

Tokens, webhook URLs and HTTP header values are write-only: you supply them in plaintext on create, and they are never returned by get_notification / list_notifications_by_workspace (only a non-secret target marker and a details map of non-secret attributes). Consequence: on update you must resend the secret — an update overwrites the whole notification and cannot preserve a secret it cannot read back.

Filters shape

Pass an optional flat filters object; any omitted part means "no such filter":

filters: {
  scenarioName?:        { search: "...", matchType?: CONTAINS|EQUALS|EQUALS_IGNORECASE|CONTAINS_IGNORECASE|STARTS_WITH|ENDS_WITH },
  testDurationMinutes?: { min?: <n>, max?: <n> },
  concurrentUsers?:     { min?: <n>, max?: <n> }
}