Webhook Endpoints

List webhook endpoints

Lists public webhook endpoints for the authenticated brokerage. Customers do not pass brokerageKey; the brokerage is resolved from the API key.

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

get/v2/webhook-endpoints

Request

Response

Webhook endpoints returned 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.