Test webhook subscription

​

Sends a test delivery for a public webhook subscription. The request body is optional. If omitted, Augment sends a default test payload for the subscription's event type.

To send your own test payload, the API request body must be an object with a payload key. The value of payload should be the webhook event body you want Augment to send. Augment unwraps this field and sends only the payload value as the HTTP request body to your webhook endpoint. Use a payload value that matches the webhook event you are testing. For subscriptions created through these public APIs, refer to the version 2 event shapes documented in the Webhooks reference. You cannot create v1 webhook subscriptions through self-service management.

Use this after creating a subscription or updating the endpoint URL, auth token, or custom headers.

Path Parameters
  • subscriptionId
    Type: string
    required

    Webhook subscription ID

Body·
application/json

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 is the webhook event body that Augment sends to the configured endpoint.

  • payload
    Type: object

    Custom webhook event body to send to the subscription endpoint. Augment sends this object exactly as the webhook POST body. It should match the version 2 event shape your listener expects, such as a Track & Trace event envelope from the Webhooks reference.

Responses
  • application/json
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for post/v2/webhook-subscriptions/{subscriptionId}/test
curl 'https://api.prod.goaugment.com/v2/webhook-subscriptions/{subscriptionId}/test' \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Basic username:password' \
  --data '{
  "payload": {
    "id": "test-event-10507012-001",
    "workflow": "TRACK_AND_TRACE",
    "occurredAt": "2026-06-08T12:00:00.000Z",
    "loadNumber": "10507012",
    "customerLoadInternalId": null,
    "eventType": "TRACKING_UPDATE",
    "data": {
      "nextSequence": 1,
      "nextEtaUtc": "2026-06-09T14:00:00.000Z",
      "eventType": "PING",
      "eventSource": "PHONE_EMAIL",
      "eventUtc": "2026-06-08T12:00:00.000Z",
      "city": "Ashland",
      "stateOrProvince": "VA",
      "latitude": 37.759,
      "longitude": -77.479,
      "notes": "Driver in Ashland, VA; in transit to Westfield, MA delivery by 10:00 AM tomorrow."
    }
  }
}'

{
  "statusCode": 200,
  "body": {}
}

Test delivery result