GOgoaugment
Webhook Event Subscriptions

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.

post/v2/webhook-subscriptions/{subscriptionId}/test

Request

Request body

payloadobject

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.

Response

Test delivery result

statusCodenumber double required

HTTP status code returned by the webhook endpoint

bodyunknown required

Example response

{
  "statusCode": 200
}

Changes

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