Skip to content

TF-33257 HCP Terraform & Enterprise Docs Update Notification Configurations for Projects#1630

Merged
trujillo-adam merged 13 commits intomainfrom
jillirami/tf-33257-update-project-notification-documentation
Apr 3, 2026
Merged

TF-33257 HCP Terraform & Enterprise Docs Update Notification Configurations for Projects#1630
trujillo-adam merged 13 commits intomainfrom
jillirami/tf-33257-update-project-notification-documentation

Conversation

@jillirami
Copy link
Copy Markdown
Contributor

@jillirami jillirami commented Jan 14, 2026

Please go to the Preview tab and select the appropriate template:

Terraform

TF-33257

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 14, 2026

Vercel Previews Deployed

Name Status Preview Updated (UTC)
Dev Portal ✅ Ready (Inspect) Visit Preview Fri Apr 3 23:07:56 UTC 2026
Unified Docs API ✅ Ready (Inspect) Visit Preview Fri Apr 3 23:04:06 UTC 2026

@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Jan 14, 2026

Broken Link Checker

No broken links found! 🎉

Copy link
Copy Markdown
Contributor

@trujillo-adam trujillo-adam left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This review is just for the new UI page. I'll branch off of this PR to suggest some structural changes to the API docs. We'll also need to remove the TFE-specific page. If we merge by 4/3, TFE 2.0 will get the new content automatically.


Project notification configurations require project admin access. Refer to [Project permissions](/terraform/cloud-docs/users-teams-organizations/permissions/project#project-admin) for details.

-> **API:** Refer to [Project notification configurations API reference](/terraform/cloud-docs/api-docs/project-notification-configurations).
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
-> **API:** Refer to [Project notification configurations API reference](/terraform/cloud-docs/api-docs/project-notification-configurations).
Refer to [Project notification configurations API reference](/terraform/cloud-docs/api-docs/project-notification-configurations) for information on integrating with your notification systems.

Doesn't need to be a callout box and shouldn't be on the other pages, either.

Comment on lines +15 to +29
## How project notifications work

Project notifications work alongside workspace notifications.

### Apply to all workspaces

Project notifications trigger for all current workspaces in the project. They also trigger for any workspaces that you create in the project or move into it later.

### Combine with workspace notifications

Project notifications do not modify or remove workspace notifications. For example, if a workspace has a Slack webhook and the project has a PagerDuty webhook, the same run event triggers both notifications.

### Cannot be disabled from workspaces

Workspace administrators cannot turn off project notifications from workspace settings. You must modify or delete them at the project level.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## How project notifications work
Project notifications work alongside workspace notifications.
### Apply to all workspaces
Project notifications trigger for all current workspaces in the project. They also trigger for any workspaces that you create in the project or move into it later.
### Combine with workspace notifications
Project notifications do not modify or remove workspace notifications. For example, if a workspace has a Slack webhook and the project has a PagerDuty webhook, the same run event triggers both notifications.
### Cannot be disabled from workspaces
Workspace administrators cannot turn off project notifications from workspace settings. You must modify or delete them at the project level.
## Overview
HCP Terraform sends project notifications in addition to workspace notifications. Project notifications do not modify or remove workspace notifications. For example, if a workspace has a Slack webhook and the project has a PagerDuty webhook, the same run event triggers both notifications.
HCP Terraform sends project notifications for all current workspaces in the project. They also trigger for any workspaces that you create in the project or move into it later.
By default, HCP Terraform also sends project notifications for all current workspaces in the organization, but you can remove them from the scope during configuration.
Workspace administrators cannot turn off project notifications from workspace settings. You must modify or delete them at the project level.

This is normally call the "Overview" or "Introduction" section in a usage page. The combination of wording in the H2 and the subheadings was a little confusing to me at first because they seemed like settings.

I added the information about the default behavior because that's what I saw on staging, but I don't know if that's intentional.

Just to be clear, once you create a project-level notification, the platform sends a notification to the external app for any of the selected events for all workspaces in the project, period. You can't select the workspaces in the project that trigger the notification. The workspaces field in the UI is to send notifications when workspaces outside the project trigger the notification, correct?


## Notification payloads

Project notifications use the same payload formats as workspace notifications. Refer to [Workspace notifications](/terraform/cloud-docs/workspaces/settings/notifications#notification-payloads) for payload details and examples.
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ideally, "Notification payloads" is a standalone reference topic. No action on this comment -- it's more for me to investigate a better structure.

"title": "Manage projects",
"path": "projects/manage"
},
{ "title": "Notifications", "path": "projects/notifications" },
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll create a subbranch to propose some structural changes that I think will set us up better for future work

### Project notification triggers

The same workspace notification triggers are available for [project notifications](#project-notification-configuration).

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggestion to remove changes to this TFE file content/terraform-enterprise/1.1.x/docs/enterprise/api-docs/notification-configurations.mdx until after the release next week, to unblock this PR for TFC

trujillo-adam and others added 2 commits April 2, 2026 14:17
This PR creates a folder for the notifications API docs so that we can
more easily add or update based on constructs in the platform. I also
added a list of endpoints described in each page so that the content is
more reference-like.
@cgriggs01 cgriggs01 marked this pull request as ready for review April 3, 2026 17:17
@cgriggs01 cgriggs01 requested review from a team as code owners April 3, 2026 17:17
cgriggs01 and others added 2 commits April 3, 2026 13:50
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
@trujillo-adam trujillo-adam merged commit 54bf790 into main Apr 3, 2026
15 checks passed
@trujillo-adam trujillo-adam deleted the jillirami/tf-33257-update-project-notification-documentation branch April 3, 2026 23:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants