How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Augment Webhook Endpoints API

Public API endpoints for approved brokerages to create, update, list, and delete webhook endpoints. Self-service endpoints send version 2 webhook payloads only. Access is gated by brokerage; talk to Augment before using these endpoints.

Augment Webhook Endpoints API is one of 6 APIs that Augment publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Webhook Endpoints. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 5 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 20.0.1.

Requests are made against a single base URL, https://api.prod.goaugment.com.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
20.0.1
Base URL
https://api.prod.goaugment.com
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

Augment Webhook Endpoints API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (httpBasic). By default, every request must be authenticated.

  • httpBasic — Authenticate with HTTP Basic auth by sending an empty username and your API key as the password, equivalent to encoding : in the Basic credential.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Webhook Endpoints 5

Public API endpoints for approved brokerages to create, update, list, and delete webhook endpoints. Self-service endpoints send version 2 webhook payloads only. Access is gated by…

GET
/v2/webhook-endpoints
List webhook endpoints
listWebhookEndpoints → 200400401403
POST
/v2/webhook-endpoints
Create webhook endpoint
createWebhookEndpoint body → 201400401403
GET
/v2/webhook-endpoints/{webhookEndpointId}
Get webhook endpoint
getWebhookEndpoint 1 param → 200400401403404
PATCH
/v2/webhook-endpoints/{webhookEndpointId}
Update webhook endpoint
updateWebhookEndpoint 1 param body → 200400401403404
DELETE
/v2/webhook-endpoints/{webhookEndpointId}
Delete webhook endpoint
deleteWebhookEndpoint 1 param → 204400401403404409

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are WebhookEndpoint (5 properties), CreateWebhookEndpointRequest (4 properties), UpdateWebhookEndpointRequest (4 properties), ApiErrorBody (3 properties). Each schema is shown below with its type and property counts.

WebhookEndpoint
object
Public webhook endpoint configured for outbound webhook delivery.
5 properties 3 required
CreateWebhookEndpointRequest
object
Request body for creating a public webhook endpoint.
4 properties 2 required
WebhookEndpointBearerTokenAuth
object
Bearer token authentication for webhook delivery requests.
2 properties 2 required
WebhookCustomHeaders
object
Custom headers sent with webhook deliveries.
WebhookEndpointCustomHeadersAuth
object
Authentication conveyed via the endpoint's customHeaders field (e.g. x-api-key). No bearer token is sent and Augment does not store one.
1 property 1 required
ApiErrorBody
object
3 properties 1 required
WebhookEndpointAuth
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.
UpdateWebhookEndpointRequest
object
Request body for partially updating a public webhook endpoint. At least one field is required.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

augment-webhook-endpoints-api-openapi.yml Raw ↑

Other APIs Augment publishes across the network.

Augment API Key API
Augment Carrier Management API
Augment Carrier Support API
Augment Load Management API
Augment Webhook Event Subscriptions API
Where this information came from

This is an independent, third-party profile of Augment Webhook Endpoints API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.