---
title: "Create webhook endpoint"
method: POST
path: "/v2/webhook-endpoints"
tags: ["Webhook Endpoints"]
---

# Create webhook endpoint

`POST /v2/webhook-endpoints`

## Request

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

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.

## Request body

- CreateWebhookEndpointRequest: Request body for creating a public webhook endpoint.
  - `name` string: Optional display name for the endpoint
  - `url` string, uri, required: HTTPS URL that receives Augment webhook deliveries
  - `auth` union, required: 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 `201`

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

---

[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)