Webhooks

Test a webhook

Send a test webhook to the configured URL. The test webhook will include:

  • X-Signature header with HMAC-SHA256 signature
  • X-Timestamp header with Unix timestamp
  • Test event data with event_type: 'test'

This allows you to verify your webhook endpoint is correctly configured.

post/nhsapi/v1/Webhooks/{id}/test

Request

  • Base URL: https://www.example.com
  • URL: https://www.example.com/nhsapi/v1/Webhooks/{id}/test
  • Auth: none declared

Headers

X-External-Account-Tokenstring

External account token for authentication

Response

test result

successboolean

Whether the test was successful

status_codeinteger

HTTP status code received

bodystring

Response body received

errorstring nullable

Error message if test failed

Example response

{
  "success": true,
  "status_code": 200,
  "body": "OK"
}

Changes

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