Outcome

Register a post-call assertion against a suite

After a scored run for suiteId (optionally narrowed to one scenario by scenarioName), Word Is Bond POSTs a signed request to endpoint and evaluates the matchers. The endpoint MUST be a public https URL; internal, loopback, link-local, and cloud-metadata hosts are rejected at registration. expected.json_path maps a JSONPath to an expected value (or the sentinels $exists / $absent); values may interpolate the scenario, e.g. {{scenario.requested_date}}. priceCheck compares the price the agent quoted against an uploaded price list. Method is POST and trigger is post_call in v0.

post/api/outcome/assertions

Request

  • Base URL: https://api.wordis-bond.com
  • URL: https://api.wordis-bond.com/api/outcome/assertions
  • Auth: HTTP bearer

Request body

suiteIdstring uuid

The suite this assertion is attached to (required on create).

scenarioNamestring nullable

Only run for this scenario (persona name). Null = every scenario.

namestring
endpointstring uri
method'POST'
timeoutMsinteger

Per-request timeout, capped at 10000.

retriesinteger

Retry attempts on an unreachable/5xx call, capped at 3.

enabledboolean

Example request

{
  "endpoint": "https://hooks.acme.com/wb-outcome",
  "expected": {
    "json_path": {
      "$.booking.status": "confirmed",
      "$.booking.date": "{{scenario.requested_date}}"
    }
  },
  "priceCheck": {
    "source": "price_list_ref:<priceListId>"
  }
}

Response

Created

Example response

{
  "data": {
    "endpoint": "https://hooks.acme.com/wb-outcome",
    "expected": {
      "json_path": {
        "$.booking.status": "confirmed",
        "$.booking.date": "{{scenario.requested_date}}"
      }
    },
    "priceCheck": {
      "source": "price_list_ref:<priceListId>"
    }
  }
}

Changes

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