Sign in

v1

latestOpenAPI 3.1.02026-08-04127114.4 KB
Webhook Configurations

Test Webhook

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.

post/webhook-configurations/test

Request body

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_urlstring uri required

URL to send the test payload to.

Example request

{
  "callback_url": "https://your-server.com/webhooks/enrichment"
}

Response

Test webhook result.

successboolean

Whether the test webhook was successfully delivered.

statusinteger

The HTTP status code returned by the callback URL.

messagestring

A message describing the result of the test.

Example response

{
  "success": true,
  "status": 200,
  "message": "Test webhook sent successfully"
}