---
title: "Test Webhook"
method: POST
path: "/webhook-configurations/test"
tags: ["Webhook Configurations"]
---

# Test Webhook

`POST /webhook-configurations/test`

Test your webhook endpoint by triggering a sample payload. Useful for verifying your webhook receiver is working correctly.

The test payload varies by webhook type:
- **ENRICHMENT_DATA**: Sample enriched transactions payload
- **ENRICHMENT_NOTIFICATION**: Sample batch notification with batch_request_id
- **USER_TAGS_DATA**: Sample user tags payload with created/deleted/modified arrays
- **USER_TAGS_NOTIFICATION**: Sample notification with guid
- **INSIGHTS**: Sample finsights array

All test webhooks include the `X-Webhook-Verification` header for signature verification testing.

## Request body

- object
  - `webhook_type` 'ENRICHMENT_DATA' | 'ENRICHMENT_NOTIFICATION' | 'USER_TAGS_DATA' | 'USER_TAGS_NOTIFICATION' | 'INSIGHTS', required — The type of webhook to configure: - `ENRICHMENT_DATA`: Data-rich Transaction Enrichment webhooks (full payload) - `ENRICHMENT_NOTIFICATION`: Non-data-rich Enrichment webhooks (notification only, fetch data from the `/cleanup/{batch_request_id}` endpoint) - `USER_TAGS_DATA`: Data-rich User Tags webhooks (full payload) - `USER_TAGS_NOTIFICATION`: Non-data-rich User Tags webhooks (notification only) - `INSIGHTS`: Finsights/insights webhooks
  - `callback_url` string, uri, required — URL to send the test payload to.

## Response `200`

Test webhook result.

- object
  - `success` boolean — Whether the test webhook was successfully delivered.
  - `status` integer — The HTTP status code returned by the callback URL.
  - `message` string — A message describing the result of the test.

## Other responses

- `400` — Bad request. Possible errors: - `client_id header is required` - `webhook_type is required` - `Invalid webhook_type` - `callback_url is required` - `callback_url must be a valid URL`
- `401` — Unauthorized.
- `403` — Missing required `enrichment` scope.

---

[API](https://skmtc.dev/fingoal/apis/insights-api.md) · [All operations](https://skmtc.dev/fingoal/apis/insights-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/fingoal/insights-api/revisions/00cf4dbd5441/schema)
