GOgoaugment
Webhook Endpoints

Create webhook endpoint

Creates a public webhook endpoint for the authenticated brokerage. The endpoint URL must use HTTPS. Created endpoints use webhook payload version 2 and TLS verification. You cannot create v1 webhook subscriptions through self-service management. After creating an endpoint, create a webhook subscription that points to the returned id.

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

post/v2/webhook-endpoints

Request

Request body

namestring

Optional display name for the endpoint

urlstring uri required

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",
  "auth": {
    "token": "customer-secret-token"
  },
  "customHeaders": {
    "X-Customer-Header": "value"
  }
}

Response

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