GOgoaugment
Webhook Event Subscriptions

Update webhook subscription

Partially updates a public webhook subscription. Only webhookEndpointId and isActive are updatable. eventType is not updatable; create a new subscription to change event type. At least one field is required.

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

patch/v2/webhook-subscriptions/{subscriptionId}

Request

Request body

webhookEndpointIdstring

New webhook endpoint ID for this subscription

isActiveboolean

Whether this subscription should be active

Example request

{
  "webhookEndpointId": "webhook_endpoint_01HZ..."
}

Response

Webhook subscription updated 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.