---
title: "Update webhook endpoint"
method: PATCH
path: "/v2/webhook-endpoints/{webhookEndpointId}"
tags: ["Webhook Endpoints"]
---

# Update webhook endpoint

`PATCH /v2/webhook-endpoints/{webhookEndpointId}`

## Request

- Base URL: `https://api.prod.goaugment.com`
- URL: `https://api.prod.goaugment.com/v2/webhook-endpoints/{webhookEndpointId}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/goaugment/apis/augment-api/docs/v2/webhook-endpoints/:webhookEndpointId/patch.ts> (a function with typed inputs; its response is checked against the schema)

Partially updates a public webhook endpoint. Supported fields are `name`, `url`, `auth`, and `customHeaders`. At least one field is required. Omitted fields are preserved. Passing `customHeaders: null` clears custom headers. Existing webhook subscriptions stay attached to the same endpoint ID. After changing the endpoint URL or auth, test each affected subscription.

Access to webhook management is gated by brokerage. Talk to Augment to enable access before relying on this endpoint.

## Request body

- UpdateWebhookEndpointRequest: Request body for partially updating a public webhook endpoint. At least one field is required.
  - `name` string: Display name for the endpoint
  - `url` string, uri: HTTPS URL that receives Augment webhook deliveries
  - `auth` union: Outbound auth configuration used when Augment delivers webhooks to your endpoint. This is not the same as the API key auth used to call Augment.
    - WebhookEndpointBearerTokenAuth: Bearer token authentication for webhook delivery requests.
      - `type` 'bearerToken', required: Bearer token auth.
      - `token` string, required: Secret token sent as `Authorization: Bearer <token>` on webhook delivery. This token is never returned by read or list responses.
    - WebhookEndpointCustomHeadersAuth: Authentication conveyed via the endpoint's `customHeaders` field (e.g. `x-api-key`). No bearer token is sent and Augment does not store one.
      - `type` 'customHeaders', required: Custom headers auth.
  - `customHeaders` WebhookCustomHeaders: Custom headers sent with webhook deliveries.

## Response `200`

Webhook endpoint updated successfully

- WebhookEndpoint: Public webhook endpoint configured for outbound webhook delivery.
  - `id` string, required: Webhook endpoint ID
  - `name` string: Display name for the endpoint
  - `url` string, uri, required: HTTPS URL that receives Augment webhook deliveries
  - `authType` 'bearerToken' | 'customHeaders', required: Outbound delivery auth type. Tokens are never returned by read or list responses.
  - `customHeaders` WebhookCustomHeaders: Custom headers sent with webhook deliveries.

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Webhook management access is not enabled for this brokerage
- `404`: Webhook endpoint not found

---

[API](https://skmtc.dev/goaugment/apis/augment-api.md) - [All operations](https://skmtc.dev/goaugment/apis/augment-api/llms.txt) - [OpenAPI document](https://skmtc.dev/goaugment/apis/augment-api/revisions/b61097634d79?raw)