GOgoaugment
Webhook Event Subscriptions

Create webhook subscription

Creates a subscription from a public webhook endpoint to one public event type. isActive is optional and defaults to true. The endpoint must exist and must be a public webhook endpoint for the authenticated brokerage. Duplicate subscriptions for the same webhookEndpointId and eventType are rejected with 409. After creating the subscription, send a test delivery for the returned subscription id. Subscriptions created through these public APIs deliver version 2 webhook event shapes for the selected event type.

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

post/v2/webhook-subscriptions

Request

Request body

webhookEndpointIdstring required

Webhook endpoint ID that should receive this event type

eventType'TRACKING_UPDATE' | 'STOP_UPDATE' | 'LOAD_CARRIER_UPDATE' | 'SEND_TMS_COMMENT' | 'SCHEDULED_CARRIER_OUTREACH' | 'UPLOAD_FILES' | 'PUSH_BID_TO_TMS' | 'PUSH_LOAD_DRAFT' | 'CARRIER_ISSUE_UPDATED' required

Public event type for webhook subscription creation. Call GET /v2/webhook-event-types for the current source of truth.

isActiveboolean

Whether this subscription should be active. Defaults to true.

Example request

{
  "webhookEndpointId": "webhook_endpoint_01HY..."
}

Response

Webhook subscription created successfully

idstring required

Webhook subscription ID

webhookEndpointIdstring required

Webhook endpoint ID that receives this event type

eventType'TRACKING_UPDATE' | 'STOP_UPDATE' | 'LOAD_CARRIER_UPDATE' | 'SEND_TMS_COMMENT' | 'SCHEDULED_CARRIER_OUTREACH' | 'UPLOAD_FILES' | 'PUSH_BID_TO_TMS' | 'PUSH_LOAD_DRAFT' | 'CARRIER_ISSUE_UPDATED' required

Public event type for webhook subscription creation. Call GET /v2/webhook-event-types for the current source of truth.

isActiveboolean required

Whether this subscription is active

Example response

{
  "id": "webhook_subscription_01HY...",
  "webhookEndpointId": "webhook_endpoint_01HY...",
  "isActive": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.