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 Event Subscriptions API

Public API endpoints for approved brokerages to list supported webhook event types, subscribe endpoints to event types, and send test deliveries. Subscriptions created through these public APIs deliver version 2 webhook event shapes only. Access is gated by brokerage; talk to Augment before using these endpoints.

Augment Webhook Event Subscriptions 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 Event Subscriptions. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.

This API exposes 7 operations across 4 paths, and defines 7 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.

7 operations 4 paths 7 schemas 1 DELETE3 GET1 PATCH2 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 Event Subscriptions 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 7

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

Webhook Event Subscriptions 7

Public API endpoints for approved brokerages to list supported webhook event types, subscribe endpoints to event types, and send test deliveries. Subscriptions created through the…

GET
/v2/webhook-event-types
List webhook event types
listWebhookEventTypes → 200400401403
GET
/v2/webhook-subscriptions
List webhook subscriptions
listWebhookSubscriptions → 200400401403
POST
/v2/webhook-subscriptions
Create webhook subscription
createWebhookSubscription body → 201400401403409
GET
/v2/webhook-subscriptions/{subscriptionId}
Get webhook subscription
getWebhookSubscription 1 param → 200400401403404
PATCH
/v2/webhook-subscriptions/{subscriptionId}
Update webhook subscription
updateWebhookSubscription 1 param body → 200400401403404409
DELETE
/v2/webhook-subscriptions/{subscriptionId}
Delete webhook subscription
deleteWebhookSubscription 1 param → 204400401403404409
POST
/v2/webhook-subscriptions/{subscriptionId}/test
Test webhook subscription
testWebhookSubscription 1 param body → 200400401403404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are WebhookSubscription (4 properties), ApiErrorBody (3 properties), CreateWebhookSubscriptionRequest (3 properties), UpdateWebhookSubscriptionRequest (2 properties). Each schema is shown below with its type and property counts.

WebhookSubscription
object
Public webhook subscription connecting one webhook endpoint to one event type.
4 properties 4 required
CreateWebhookSubscriptionRequest
object
Request body for creating a public webhook subscription.
3 properties 2 required
TestWebhookSubscriptionRequest
object
Optional request body for a test webhook delivery. The request body uses a payload wrapper: the payload key is part of this API request, and the payload value…
1 property
WebhookManagementEventType
string
Public event type for webhook subscription creation. Call GET /v2/webhook-event-types for the current source of truth.
TestWebhookSubscriptionResponse
object
2 properties 2 required
UpdateWebhookSubscriptionRequest
object
Request body for partially updating a public webhook subscription. At least one field is required. eventType is not updatable.
2 properties
ApiErrorBody
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

augment-webhook-event-subscriptions-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 Endpoints API
Where this information came from

This is an independent, third-party profile of Augment Webhook Event Subscriptions 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.