{
  "version": "1.0",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metric": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "call": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "callDirection": "INBOUND",
    "startedAt": "2026-10-26T14:00:02.000Z",
    "endedAt": "2023-11-07T05:31:56Z",
    "durationMs": 123,
    "endedStatus": "<string>",
    "externalId": "<string>",
    "agents": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "endpoint": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "environment": "<string>",
          "phoneNumberE164": "<string>"
        }
      }
    ],
    "customers": [
      {
        "phoneNumberE164": "<string>",
        "label": "<string>"
      }
    ],
    "properties": {
      "cardId": "card_123"
    }
  },
  "simulation": {
    "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "runPlanJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "flow": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>"
    },
    "testCase": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "isDefault": true
    },
    "variables": {
      "cardNumber": "4111111111111111",
      "newPin": "4821"
    },
    "persona": {}
  }
}

{
  "passed": true,
  "reason": "<string>"
}

Metric

Http request metric

What an HTTP request metric sends to your endpoint, and the answer it expects. Roark sends it once per call the metric grades, live or simulated, after the call is analysed.

With no body template, Roark POSTs the payload below. A body template fills {{path}} placeholders from the same payload, for example {{call.properties.cardId}} or {{simulation.variables.newPin}}. A placeholder the call has no value for (a run variable on a live call) skips the request and records the metric as missing data.

Answer with HTTP 200 and {"passed": true | false, "reason": "..."} within 30 seconds. Timeouts, connection failures and 5xx responses are retried twice with the same requestId, so drop a request you have already answered. Any other answer records an error on the metric, never a fail. Redirects are not followed.

WEBHOOK

HttpRequestMetric

{
  "version": "1.0",
  "requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "metric": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "call": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "projectId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "callDirection": "INBOUND",
    "startedAt": "2026-10-26T14:00:02.000Z",
    "endedAt": "2023-11-07T05:31:56Z",
    "durationMs": 123,
    "endedStatus": "<string>",
    "externalId": "<string>",
    "agents": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "endpoint": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "environment": "<string>",
          "phoneNumberE164": "<string>"
        }
      }
    ],
    "customers": [
      {
        "phoneNumberE164": "<string>",
        "label": "<string>"
      }
    ],
    "properties": {
      "cardId": "card_123"
    }
  },
  "simulation": {
    "jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "runPlanJobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "flow": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>"
    },
    "testCase": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "title": "<string>",
      "isDefault": true
    },
    "variables": {
      "cardNumber": "4111111111111111",
      "newPin": "4821"
    },
    "persona": {}
  }
}

{
  "passed": true,
  "reason": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

version

string

required

Payload schema version

Allowed value: "1.0"

requestId

string<uuid>

required

Unique per request. Quote it when reporting a problem.

metric

object

required

Show child attributes

call

object

required

Show child attributes

simulation

object | null

required

Set when the call is a Roark simulation, null on a live call

Show child attributes

Response

200 - application/json

The verdict for this call.

passed

boolean

required

Whether the call did what it should

reason

string

Shown next to the result in Roark. Longer than 1000 characters is cut.