GOgoaugment
Webhook Endpoints

Update webhook endpoint

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.

patch/v2/webhook-endpoints/{webhookEndpointId}

Request

Request body

namestring

Display name for the endpoint

urlstring uri

HTTPS URL that receives Augment webhook deliveries

customHeadersWebhookCustomHeaders

Custom headers sent with webhook deliveries.

Example request

{
  "name": "Primary Webhook",
  "url": "https://example.com/webhooks/augment-v2",
  "auth": {
    "token": "customer-secret-token"
  },
  "customHeaders": {
    "X-Customer-Header": "value"
  }
}

Response

Webhook endpoint updated successfully

idstring required

Webhook endpoint ID

namestring

Display name for the endpoint

urlstring 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.

customHeadersWebhookCustomHeaders

Custom headers sent with webhook deliveries.

Example response

{
  "id": "webhook_endpoint_01HY...",
  "name": "Primary Webhook",
  "url": "https://example.com/webhooks/augment",
  "customHeaders": {
    "X-Customer-Header": "value"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.