Skip to main content

Manage customer release webhooks

Beta Feature

The Enterprise Portal is Beta. Features described on this page are subject to change.

Customers can use release.available webhook events to start upgrade pipelines and other automations. Each customer team can register one endpoint in the Enterprise Portal. You can view its status and delivery history in the Vendor Portal.

Send release events​

When promoting a release, select Notify users in the Vendor Portal or pass --notify-users with the Replicated CLI. Replicated sends the webhook event after the release artifacts become downloadable for the customer. For more information, see Release notifications in Customize Customer Emails.

Receiving customers include any non-archived customer assigned to the channel the new release has been promoted to.

Webhook configuration applies to the customer's team. Customers opt in by registering an endpoint. Individual users opt in or out of release notification emails separately in User Settings, and an email opt-out doesn't stop webhook deliveries.

Configure a customer endpoint​

Customer team admins manage their endpoint from Team Settings > Webhooks in the Enterprise Portal. Vendors view status and deliveries from the Vendor Portal. Customers make configuration changes in their own portal. Vendors can't view or change a customer's webhook from a Login as customer session.

To configure an endpoint, a customer team admin completes these steps:

  1. Log in to the Enterprise Portal and go to Team Settings > Webhooks.

  2. Enter a publicly reachable HTTP or HTTPS URL in Endpoint URL, then click Register webhook.

  3. Copy the signing secret and save it in the webhook receiver. The portal shows the secret only after registration or rotation.

  4. Follow Receiving and verifying events on the same page to configure signature verification and event handling in the receiver.

  5. Click Send test event and check Recent deliveries to verify the receiver accepts the event.

Test events contain test: true and synthetic release details. Receivers should acknowledge test events without starting an upgrade. The customer's delivery history includes tests. The Vendor Portal shows only real release deliveries.

Customers can also edit the endpoint URL, rotate the signing secret, or delete the webhook from this page. They can disable and enable it as needed.

View webhook status and deliveries​

To check a customer's release webhook:

  1. In the Vendor Portal, go to Customers and select the customer.

  2. Open Enterprise Portal access and find the Release webhook card near Email History.

  3. Click Refresh to retrieve the latest status and delivery history.

The card shows whether the customer has configured a webhook and its enabled or disabled status. For disabled webhooks, it displays the reason and disable date prominently. Older records without a stored disable date display Disable date unavailable.

Configuration details include the endpoint hostname, the email address of the person who configured it, and the creation date. Vendors cannot view the full endpoint URL, signing secret, or endpoint response headers and body.

The Recent deliveries table shows the release and channel, status, latest HTTP response status, total attempt count, last attempt, and expected next retry. A dash means that a value is unavailable or does not apply. To view additional deliveries, click Previous or Next.

StatusMeaning
DeliveredThe endpoint returned an HTTP 2xx response.
PendingThe delivery is waiting for its first attempt or a retry.
FailedThe delivery exhausted its retry attempts without a successful response.
CanceledThe delivery stopped before completion, for example after a customer disables or deletes the webhook.

Delivered confirms that the endpoint accepted the event. Check the customer's pipeline separately to confirm that an upgrade ran successfully.

Permissions​

Viewing webhook status and deliveries requires both of these RBAC resources:

  • kots/app/[:appid]/enterprise-portal/webhooks/read
  • kots/app/[:appid]/license/[:customerid]/read

Email history uses a separate permission and does not grant webhook access. For more information, see RBAC resource names and Configure RBAC policies.

Recover a disabled webhook​

Each delivery has up to nine attempts: the initial request and eight retries, with retry delays increasing from 15 seconds to 10 minutes. After ten consecutive failed release deliveries, Replicated automatically disables the endpoint. Test events do not count toward this limit.

To restore delivery, the customer team admin completes these steps:

  1. Correct the receiver problem, using the delivery attempt details in Team Settings > Webhooks in the Enterprise Portal.

  2. Click Enable webhook.

  3. Click Send test event and verify that the endpoint accepts it.

Vendors can check the status again with Refresh on the Release webhook card.

On this page