DocsRequest structure
01 / 04

Request structure

The data Nodox sends to your webhook.

Incoming request

When you run a test, Nodox sends a POST request to your webhook URL with a JSON body containing two main parts:

  • payload - The test data you need to process
  • metadata - Information about where to send your response

Field reference

payloadThe test data you need to process. This changes per test case.
callbackUrlWhere to send your response (POST request).
callbackTokenSend this as the x-nodox-token header in your response.
mockApiBaseBase URL for calling mock APIs (if the brief requires API calls).

Example payload

Request body
{
  "payload": {
    "userId": "USR-001"
  },
  "metadata": {
    "callbackUrl": "https://nodox.ai/api/callbacks/abc123",
    "callbackToken": "token_xyz789",
    "mockApiBase": "https://nodox.ai/api/mock/attempt123"
  }
}