Webhooks

Send a test event to the webhook endpoint.

Sends a synthetic case.created test event to the webhook endpoint.

This is useful for:

  • Verifying the webhook URL is reachable
  • Testing your webhook endpoint implementation
  • Validating signature verification

The test payload will be a realistic case.created event with synthetic data.

post/webhooks/{id}/test

Request

  • Base URL
    https://customer-api.debitura.com
  • URL
    https://customer-api.debitura.com/webhooks/{id}/test
  • Auth
    • API key in header XApiKey
    • or HTTP bearer

Path parameters

idstring uuid required

Response

Test completed

successboolean

Whether the test delivery was successful.

httpStatusCodeinteger nullable

HTTP status code returned by the webhook endpoint.

durationMsinteger nullable

Duration of the HTTP request in milliseconds.

errorMessagestring nullable

Error message if the delivery failed.

errorCategorystring nullable

Category of the error (TimeoutError, NetworkError, SslError, HttpError, UnknownError).

testPayloadunknown

Changes

No recorded changes to this operation across all 9 revisions of this API.