Email Notifications
Breakwater emails people when something changes that affects them: their access to your team, your customers' licenses, and registry tokens. There's nothing to set up. Emails go to the address on each person's Breakwater account, and none of them ever contains a token secret.
These are the emails about your team, your customers and their access. Breakwater also sends account emails (password resets, two-factor changes, sign-in method changes) to the person concerned.
Your Team
| Who gets it | When | |
|---|---|---|
| You've been added | The new teammate | They accept an invitation, or join through single sign-on on their first sign-in. The email gives the role they end up with, including one set by your identity provider's groups. |
| Your role changed | The teammate | Their role changes, whether an owner or admin changed it or your identity provider did. |
| You've been removed | The person removed | They're removed from your team, by a teammate or by your identity provider. It tells them that the API tokens they created for your team were revoked, and gives your contact email if you've set one. |
| New customer added | Your team's owners | A customer is created in the vendor portal, through the API or MCP, or during onboarding. An owner gets it even when they created the customer themselves. |
The owner who creates a new vendor account doesn't get a "You've been added" email.
Your Customers' Licenses
License emails go to the customer's admins. They name your vendor account and, if you've set one, your contact email, which is also the Reply-To address. Admins and owners set the contact email under Settings.
| When | |
|---|---|
| Your license is now active | A Pending license reaches its Starts At date and Breakwater activates it (within the hour), or you create, change or renew a license so that it's Active and in force now. A license saved as Active with a future Starts At gets no email, either when you save it or when that date comes; issue it as Pending if the customer should hear when it starts. |
| Your license expires in N days | 30 days and 7 days before the license expires, unless you've turned expiry reminders off or issued a newer license that replaces it. See Customers. |
| Your license has expired | An active license reaches its end date. It isn't sent when another license replaces the one that expired, or for a license that never started. |
Customers with no admin get no license emails. Turning expiry reminders off under Settings stops only the reminders, not the activated and expired emails.
Registry Tokens
| Who gets it | When | |
|---|---|---|
| A new registry token was created | For a vendor token, your team's admins and owners. For a customer token, that customer's admins. The person who created it gets one too. | Any registry token is created: in either portal, through the API or MCP, or during onboarding. |
| Your registry token expires in N days | The person who created the token | 14 days and 3 days before it expires. A token inside both windows gets only the nearer reminder. |
| Your registry token was revoked | The person who created the token | Someone revokes it. The email says who revoked it, when that's known. |
Members and viewers on your team aren't sent the created email for a token someone else made. The created email names the token and shows its username, which isn't secret, and asks the recipient to revoke the token right away if they didn't expect it.
The expiry and revoked emails aren't sent when Breakwater doesn't know who created the token, or when that person has left the team they belong to for that token: the customer's team for a token made in the customer portal, your vendor team for a customer token you made in the vendor portal, through the API or MCP. Tokens that never expire get no reminder. See Registry Tokens.
API tokens have their own reminder: Breakwater emails the token's owner 7 days before an API token expires. See API Authentication.
Webhooks
When a webhook endpoint is disabled after repeated failures, the members, admins and owners of your team get an email. See Webhooks.