---
title: "Test webhook subscription"
method: POST
path: "/v2/webhook-subscriptions/{subscriptionId}/test"
tags: ["Webhook Event Subscriptions"]
---

# Test webhook subscription

`POST /v2/webhook-subscriptions/{subscriptionId}/test`

## Request

- Base URL: `https://api.prod.goaugment.com`
- URL: `https://api.prod.goaugment.com/v2/webhook-subscriptions/{subscriptionId}/test`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/goaugment/apis/augment-api/docs/v2/webhook-subscriptions/:subscriptionId/test/post.ts> (a function with typed inputs; its response is checked against the schema)

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](/webhooks). 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.

## Request body

- TestWebhookSubscriptionRequest: 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` 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.

## Response `200`

Test delivery result

- TestWebhookSubscriptionResponse
  - `statusCode` number, double, required: HTTP status code returned by the webhook endpoint
  - `body` unknown, required

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Webhook subscription not found

---

[API](https://skmtc.dev/goaugment/apis/augment-api.md) - [All operations](https://skmtc.dev/goaugment/apis/augment-api/llms.txt) - [OpenAPI document](https://skmtc.dev/goaugment/apis/augment-api/revisions/b61097634d79?raw)