GOgoaugment
Webhook Endpoints

Get webhook endpoint

Returns one public webhook endpoint for the authenticated brokerage. Returns 404 if the endpoint does not exist or is not a public webhook endpoint for that brokerage.

get/v2/webhook-endpoints/{webhookEndpointId}

Request

Response

Webhook endpoint 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.