GOgoaugment
Webhook Event Subscriptions

Get webhook subscription

Returns one public webhook subscription for the authenticated brokerage, or 404 if no matching public subscription exists.

get/v2/webhook-subscriptions/{subscriptionId}

Request

Response

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