Check One Event

POST

api

event

cURL

curl --request POST \
  --url https://eu.whitecircle.com/api/event \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'whitecircle-version: <whitecircle-version>' \
  --data '
{
  "environment_id": "<string>",
  "event": {
    "role": "<string>",
    "content": "<unknown>",
    "delta": "<unknown>",
    "arguments": "<unknown>",
    "output": "<unknown>",
    "definition": "<unknown>",
    "input": "<unknown>",
    "instructions": "<unknown>",
    "state": "<unknown>",
    "event_id": "<string>",
    "run_id": "<string>",
    "external_session_id": "<string>",
    "parent_event_id": "<string>",
    "links": [
      {
        "event_id": "<string>",
        "run_id": "<string>"
      }
    ],
    "external_artifact_id": "<string>",
    "name": "<string>",
    "call_id": "<string>",
    "stream_id": "<string>",
    "sequence": 123,
    "format": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "metadata": "<unknown>"
  },
  "run_id": "<string>",
  "external_session_id": "<string>",
  "role": "<string>"
}
'

import requests

url = "https://eu.whitecircle.com/api/event"

payload = {
    "environment_id": "<string>",
    "event": {
        "role": "<string>",
        "content": "<unknown>",
        "delta": "<unknown>",
        "arguments": "<unknown>",
        "output": "<unknown>",
        "definition": "<unknown>",
        "input": "<unknown>",
        "instructions": "<unknown>",
        "state": "<unknown>",
        "event_id": "<string>",
        "run_id": "<string>",
        "external_session_id": "<string>",
        "parent_event_id": "<string>",
        "links": [
            {
                "event_id": "<string>",
                "run_id": "<string>"
            }
        ],
        "external_artifact_id": "<string>",
        "name": "<string>",
        "call_id": "<string>",
        "stream_id": "<string>",
        "sequence": 123,
        "format": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "metadata": "<unknown>"
    },
    "run_id": "<string>",
    "external_session_id": "<string>",
    "role": "<string>"
}
headers = {
    "whitecircle-version": "<whitecircle-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'whitecircle-version': '<whitecircle-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    environment_id: '<string>',
    event: {
      role: '<string>',
      content: '<unknown>',
      delta: '<unknown>',
      arguments: '<unknown>',
      output: '<unknown>',
      definition: '<unknown>',
      input: '<unknown>',
      instructions: '<unknown>',
      state: '<unknown>',
      event_id: '<string>',
      run_id: '<string>',
      external_session_id: '<string>',
      parent_event_id: '<string>',
      links: [{event_id: '<string>', run_id: '<string>'}],
      external_artifact_id: '<string>',
      name: '<string>',
      call_id: '<string>',
      stream_id: '<string>',
      sequence: 123,
      format: '<string>',
      timestamp: '2023-11-07T05:31:56Z',
      metadata: '<unknown>'
    },
    run_id: '<string>',
    external_session_id: '<string>',
    role: '<string>'
  })
};

fetch('https://eu.whitecircle.com/api/event', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu.whitecircle.com/api/event",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'environment_id' => '<string>',
    'event' => [
        'role' => '<string>',
        'content' => '<unknown>',
        'delta' => '<unknown>',
        'arguments' => '<unknown>',
        'output' => '<unknown>',
        'definition' => '<unknown>',
        'input' => '<unknown>',
        'instructions' => '<unknown>',
        'state' => '<unknown>',
        'event_id' => '<string>',
        'run_id' => '<string>',
        'external_session_id' => '<string>',
        'parent_event_id' => '<string>',
        'links' => [
                [
                                'event_id' => '<string>',
                                'run_id' => '<string>'
                ]
        ],
        'external_artifact_id' => '<string>',
        'name' => '<string>',
        'call_id' => '<string>',
        'stream_id' => '<string>',
        'sequence' => 123,
        'format' => '<string>',
        'timestamp' => '2023-11-07T05:31:56Z',
        'metadata' => '<unknown>'
    ],
    'run_id' => '<string>',
    'external_session_id' => '<string>',
    'role' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "whitecircle-version: <whitecircle-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eu.whitecircle.com/api/event"

	payload := strings.NewReader("{\n  \"environment_id\": \"<string>\",\n  \"event\": {\n    \"role\": \"<string>\",\n    \"content\": \"<unknown>\",\n    \"delta\": \"<unknown>\",\n    \"arguments\": \"<unknown>\",\n    \"output\": \"<unknown>\",\n    \"definition\": \"<unknown>\",\n    \"input\": \"<unknown>\",\n    \"instructions\": \"<unknown>\",\n    \"state\": \"<unknown>\",\n    \"event_id\": \"<string>\",\n    \"run_id\": \"<string>\",\n    \"external_session_id\": \"<string>\",\n    \"parent_event_id\": \"<string>\",\n    \"links\": [\n      {\n        \"event_id\": \"<string>\",\n        \"run_id\": \"<string>\"\n      }\n    ],\n    \"external_artifact_id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"call_id\": \"<string>\",\n    \"stream_id\": \"<string>\",\n    \"sequence\": 123,\n    \"format\": \"<string>\",\n    \"timestamp\": \"2023-11-07T05:31:56Z\",\n    \"metadata\": \"<unknown>\"\n  },\n  \"run_id\": \"<string>\",\n  \"external_session_id\": \"<string>\",\n  \"role\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("whitecircle-version", "<whitecircle-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://eu.whitecircle.com/api/event")
  .header("whitecircle-version", "<whitecircle-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"environment_id\": \"<string>\",\n  \"event\": {\n    \"role\": \"<string>\",\n    \"content\": \"<unknown>\",\n    \"delta\": \"<unknown>\",\n    \"arguments\": \"<unknown>\",\n    \"output\": \"<unknown>\",\n    \"definition\": \"<unknown>\",\n    \"input\": \"<unknown>\",\n    \"instructions\": \"<unknown>\",\n    \"state\": \"<unknown>\",\n    \"event_id\": \"<string>\",\n    \"run_id\": \"<string>\",\n    \"external_session_id\": \"<string>\",\n    \"parent_event_id\": \"<string>\",\n    \"links\": [\n      {\n        \"event_id\": \"<string>\",\n        \"run_id\": \"<string>\"\n      }\n    ],\n    \"external_artifact_id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"call_id\": \"<string>\",\n    \"stream_id\": \"<string>\",\n    \"sequence\": 123,\n    \"format\": \"<string>\",\n    \"timestamp\": \"2023-11-07T05:31:56Z\",\n    \"metadata\": \"<unknown>\"\n  },\n  \"run_id\": \"<string>\",\n  \"external_session_id\": \"<string>\",\n  \"role\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.whitecircle.com/api/event")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["whitecircle-version"] = '<whitecircle-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"environment_id\": \"<string>\",\n  \"event\": {\n    \"role\": \"<string>\",\n    \"content\": \"<unknown>\",\n    \"delta\": \"<unknown>\",\n    \"arguments\": \"<unknown>\",\n    \"output\": \"<unknown>\",\n    \"definition\": \"<unknown>\",\n    \"input\": \"<unknown>\",\n    \"instructions\": \"<unknown>\",\n    \"state\": \"<unknown>\",\n    \"event_id\": \"<string>\",\n    \"run_id\": \"<string>\",\n    \"external_session_id\": \"<string>\",\n    \"parent_event_id\": \"<string>\",\n    \"links\": [\n      {\n        \"event_id\": \"<string>\",\n        \"run_id\": \"<string>\"\n      }\n    ],\n    \"external_artifact_id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"call_id\": \"<string>\",\n    \"stream_id\": \"<string>\",\n    \"sequence\": 123,\n    \"format\": \"<string>\",\n    \"timestamp\": \"2023-11-07T05:31:56Z\",\n    \"metadata\": \"<unknown>\"\n  },\n  \"run_id\": \"<string>\",\n  \"external_session_id\": \"<string>\",\n  \"role\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "flagged": true,
  "policies": {
    "70289e06-9111-463e-b121-7247c2b7bfbd": {
      "flagged": true,
      "name": "No PII Sharing",
      "enabled_by_conditions": [
        {
          "id": "019f0000-0000-7000-8000-000000000001",
          "name": "EU users"
        }
      ]
    }
  },
  "event": {
    "event_id": "evt_user_001",
    "internal_event_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890",
    "status": "completed",
    "type": "message"
  },
  "run_id": "run_refund_123"
}

Check a single Event against the Policies and Metrics selected by active Conditions in your Environment. Use this endpoint for one message, tool output, function call, agent update, reasoning, or inline image artifact.

How It Works

You submit one Event with a type, one content field, and optional metadata
Conditions match the Event’s metadata and select Policies and Metrics.
Event selectors filter them to the submitted type and field
You receive synchronous Policy results, and selected Metrics continue asynchronously.

If you omit all content fields, the request becomes a reference-only Event. White Circle looks up the latest matching result by run_id and event_id.

Example Request

curl -X POST "https://eu.whitecircle.com/api/event" \
  -H "Authorization: Bearer wc-your-api-key" \
  -H "Content-Type: application/json" \
  -H "whitecircle-version: 2026-06-01" \
  -d '{
    "environment_id": "environment_123",
    "run_id": "run_refund_123",
    "external_session_id": "conversation_456",
    "event": {
      "type": "message",
      "role": "user",
      "content": "I need help with a refund. My account number is 123-45-6789.",
      "metadata": {
        "user": {
          "region": "eu"
        }
      },
      "event_id": "evt_user_001"
    }
  }'

Request Overview

Field	Type	Required	Description
`environment_id`	string	✓	Environment to use. Required for every request.
`run_id`	string		Your ID for a group of related Events. Reusing it supplies context when no `external_session_id` is sent. Generated if omitted for Events with content.
`external_session_id`	string		Your conversation or session tracking ID. Reusing it checks this Event against the previous Events of that conversation. See Event Context.
`role`	string		Role applied to `message` and `artifact` Events that do not set their own.
`event`	object	✓	Event payload to check or reference.

Event Payload

Field	Type	Required	Description
`type`	string	✓	Event type: `message`, `artifact`, `tool`, `function`, `agent`, or `reasoning`.
`event_id`	string		Your ID for this Event. Generated if omitted for Events with content. Required for references.
`run_id`	string		Event-specific group ID. If omitted, the top-level `run_id` is used.
`parent_event_id`	string		Optional same-run structural parent Event ID.
`links`	array		Causal input references as `{event_id, run_id?}`. Omit `run_id` for same-run links.
`external_session_id`	string		Event-specific session tracking ID. Overrides the top-level value for this Event’s context.
`role`	string		Role for this Event. Required for `message` Events with content when no top-level `role` is set.
`timestamp`	string		Optional ISO 8601 timestamp from your system.
`name`	string		Optional tool, function, agent, or Artifact name.
`call_id`	string		Optional tool or function call ID.
`format`	string		Optional format label from your system.
`external_artifact_id`	string		Optional Artifact tracking ID for Artifact Events.
`metadata`	object		Custom metadata, up to 256 KiB serialized.

Content Fields

Provide exactly one content field per Event.

Event type	Allowed fields
`message`	`content`
`artifact`	`content`
`tool`	`arguments`, `output`, `definition`
`function`	`arguments`, `output`, `definition`
`agent`	`input`, `instructions`, `output`, `state`
`reasoning`	`content`

tool.arguments and function.arguments accept any JSON value, including a string, number, boolean, null, array, or nested object. White Circle preserves the JSON shape for moderation. For an artifact image with raw base64 data, mime_type is optional for JPEG, PNG, WebP, and GIF content. White Circle detects the image type from the decoded bytes.

An Event can include at most one content field for evaluation. To evaluate multiple fields, submit multiple Events.

Response Overview

Field	Type	Description
`flagged`	boolean	`true` if the Event violated at least one Policy. Omitted when no check ran.
`policies`	object	Map of Policy IDs to Policy results. Omitted when no check ran.
`note`	string	Explanation of an outcome that produced no verdict.
`event`	object	The Event that was checked.
`run_id`	string	Run ID used for the Event.

The verdict is reported once, at the top level. The event object carries identity and status only.

The event object includes:

Field	Description
`type`	Event type.
`status`	`completed`, `failed`, `referenced`, or `not_found`.
`event_id`	Your ID for this Event.
`internal_event_id`	White Circle’s ID for one saved result, when available.

flagged and policies are present only when status is completed. For any other status no check ran, so the response states no verdict rather than reporting false. note explains why:

Situation	Note
No Condition selected any Policy or Metric	`No policies or metrics were selected for this Event`
A reference did not resolve	`Referenced event was not found or is not accessible`
The Event failed validation or checking	The failure reason

Each Policy object includes:

flagged — Whether this Policy was violated
name — Human-readable Policy name
enabled_by_conditions — The Conditions that selected this Policy for this Event, which is why it was evaluated. Absent when no Condition was involved.

Conditions and Metadata

White Circle evaluates active Conditions against the metadata object on this Event. Matching Conditions select the applicable Policies and Metrics. Event selectors then filter them to this Event’s type, field, and direction.

If no active Condition matches, the Event completes without evaluating any Policies and queues no Metrics. Conditions do not fall back to every Policy or Metric in the Environment.

Selected Metrics run asynchronously and are not returned in the synchronous policies map. View Metric results in the dashboard after processing completes. See Conditions for expression syntax and Policy or Metric attachments.

Parents and Links

Use one parent_event_id for the Event’s structural place in the run. Use links when an Event consumes multiple outputs or depends on Events from other runs:

{
  "event": {
    "type": "message",
    "role": "assistant",
    "content": "Combined result",
    "links": [
      { "run_id": "run_security", "event_id": "security_output" },
      { "run_id": "run_tests", "event_id": "test_output" }
    ],
    "event_id": "final_answer",
    "parent_event_id": "main_agent"
  },
  "environment_id": "environment_123",
  "run_id": "run_main"
}

Parents and links are used for auditing and navigation in this API version. White Circle does not automatically add target content to moderation context. Reference-only Events cannot declare parent_event_id or links because references are read-only lookups. White Circle returns 400 for self-parenting, direct mutual parents such as A → B → A, and parent cycles contained in one batch. It does not recursively traverse all prior cross-request ancestors on the write path.

Event Identity and Retries

run_id and event_id help you connect Events to your own application data. They are not retry keys. If you submit the same run_id and event_id again, White Circle may run another check. The latest durable attempt (completed or failed) defines the current graph relationships. Each retry replaces the complete parent/link declaration set; omitted relationships are cleared from the current graph. Use internal_event_id to refer to one saved result.

Reference an Existing Event

To reference an existing Event, send the type and event_id without a content field:

{
  "event": {
    "type": "agent",
    "event_id": "evt_agent_state_001"
  },
  "environment_id": "environment_123",
  "run_id": "run_refund_123"
}

White Circle returns referenced when the latest matching result has the same Event type. Otherwise, it returns not_found.

Tool Output Example

{
  "event": {
    "type": "tool",
    "name": "send_refund_email",
    "output": {
      "subject": "Refund approved",
      "body": "Your refund has been approved."
    },
    "event_id": "evt_tool_output_1",
    "call_id": "call_abc"
  },
  "environment_id": "environment_123",
  "run_id": "run_tool_123"
}

Authorizations

Authorization

string

header

required

API Key required. Format: Bearer wc-your-api-key

Headers

whitecircle-version

string

required

API Version

Body

application/json

environment_id

string

required

event

object

required

Hide child attributes

event.type

enum<string>

required

Available options:

message,

artifact,

tool,

function,

agent,

reasoning

event.role

string | null

event.content

any

event.delta

any

event.arguments

any

event.output

any

event.definition

any

event.input

any

event.instructions

any

event.state

any

event.event_id

string | null

event.run_id

string | null

event.external_session_id

string | null

event.parent_event_id

string | null

event.links

object[]

Hide child attributes

event.links.event_id

string

required

event.links.run_id

string | null

event.external_artifact_id

string | null

event.name

string | null

event.call_id

string | null

event.stream_id

string | null

event.sequence

integer<int64> | null

event.format

string | null

event.timestamp

string<date-time> | null

event.metadata

any

run_id

string | null

external_session_id

string | null

role

string | null

Response

Success

event

object

required

The Event a single check was run against. Identity and status only; the verdict lives on the response so it is stated exactly once.

Hide child attributes

event.type

enum<string>

required

Available options:

message,

artifact,

tool,

function,

agent,

reasoning

event.status

enum<string>

required

Available options:

completed,

failed,

referenced,

not_found

event.event_id

string

required

event.internal_event_id

string | null

run_id

string

required

flagged

boolean | null

Absent when no check ran, such as a reference, a failure, or an Event no Condition selected policies for.

policies

object | null

Hide child attributes

policies.{key}

object

Hide child attributes

policies.{key}.flagged

boolean

required

policies.{key}.name

string

required

policies.{key}.enabled_by_conditions

object[] | null

The Conditions that selected this Policy for this Event, which is why it was evaluated at all.

Hide child attributes

policies.{key}.enabled_by_conditions.id

string

required

policies.{key}.enabled_by_conditions.name

string

required

note

string | null

⌘I

cURL

curl --request POST \
  --url https://eu.whitecircle.com/api/event \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'whitecircle-version: <whitecircle-version>' \
  --data '
{
  "environment_id": "<string>",
  "event": {
    "role": "<string>",
    "content": "<unknown>",
    "delta": "<unknown>",
    "arguments": "<unknown>",
    "output": "<unknown>",
    "definition": "<unknown>",
    "input": "<unknown>",
    "instructions": "<unknown>",
    "state": "<unknown>",
    "event_id": "<string>",
    "run_id": "<string>",
    "external_session_id": "<string>",
    "parent_event_id": "<string>",
    "links": [
      {
        "event_id": "<string>",
        "run_id": "<string>"
      }
    ],
    "external_artifact_id": "<string>",
    "name": "<string>",
    "call_id": "<string>",
    "stream_id": "<string>",
    "sequence": 123,
    "format": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "metadata": "<unknown>"
  },
  "run_id": "<string>",
  "external_session_id": "<string>",
  "role": "<string>"
}
'

import requests

url = "https://eu.whitecircle.com/api/event"

payload = {
    "environment_id": "<string>",
    "event": {
        "role": "<string>",
        "content": "<unknown>",
        "delta": "<unknown>",
        "arguments": "<unknown>",
        "output": "<unknown>",
        "definition": "<unknown>",
        "input": "<unknown>",
        "instructions": "<unknown>",
        "state": "<unknown>",
        "event_id": "<string>",
        "run_id": "<string>",
        "external_session_id": "<string>",
        "parent_event_id": "<string>",
        "links": [
            {
                "event_id": "<string>",
                "run_id": "<string>"
            }
        ],
        "external_artifact_id": "<string>",
        "name": "<string>",
        "call_id": "<string>",
        "stream_id": "<string>",
        "sequence": 123,
        "format": "<string>",
        "timestamp": "2023-11-07T05:31:56Z",
        "metadata": "<unknown>"
    },
    "run_id": "<string>",
    "external_session_id": "<string>",
    "role": "<string>"
}
headers = {
    "whitecircle-version": "<whitecircle-version>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'whitecircle-version': '<whitecircle-version>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    environment_id: '<string>',
    event: {
      role: '<string>',
      content: '<unknown>',
      delta: '<unknown>',
      arguments: '<unknown>',
      output: '<unknown>',
      definition: '<unknown>',
      input: '<unknown>',
      instructions: '<unknown>',
      state: '<unknown>',
      event_id: '<string>',
      run_id: '<string>',
      external_session_id: '<string>',
      parent_event_id: '<string>',
      links: [{event_id: '<string>', run_id: '<string>'}],
      external_artifact_id: '<string>',
      name: '<string>',
      call_id: '<string>',
      stream_id: '<string>',
      sequence: 123,
      format: '<string>',
      timestamp: '2023-11-07T05:31:56Z',
      metadata: '<unknown>'
    },
    run_id: '<string>',
    external_session_id: '<string>',
    role: '<string>'
  })
};

fetch('https://eu.whitecircle.com/api/event', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://eu.whitecircle.com/api/event",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'environment_id' => '<string>',
    'event' => [
        'role' => '<string>',
        'content' => '<unknown>',
        'delta' => '<unknown>',
        'arguments' => '<unknown>',
        'output' => '<unknown>',
        'definition' => '<unknown>',
        'input' => '<unknown>',
        'instructions' => '<unknown>',
        'state' => '<unknown>',
        'event_id' => '<string>',
        'run_id' => '<string>',
        'external_session_id' => '<string>',
        'parent_event_id' => '<string>',
        'links' => [
                [
                                'event_id' => '<string>',
                                'run_id' => '<string>'
                ]
        ],
        'external_artifact_id' => '<string>',
        'name' => '<string>',
        'call_id' => '<string>',
        'stream_id' => '<string>',
        'sequence' => 123,
        'format' => '<string>',
        'timestamp' => '2023-11-07T05:31:56Z',
        'metadata' => '<unknown>'
    ],
    'run_id' => '<string>',
    'external_session_id' => '<string>',
    'role' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "whitecircle-version: <whitecircle-version>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://eu.whitecircle.com/api/event"

	payload := strings.NewReader("{\n  \"environment_id\": \"<string>\",\n  \"event\": {\n    \"role\": \"<string>\",\n    \"content\": \"<unknown>\",\n    \"delta\": \"<unknown>\",\n    \"arguments\": \"<unknown>\",\n    \"output\": \"<unknown>\",\n    \"definition\": \"<unknown>\",\n    \"input\": \"<unknown>\",\n    \"instructions\": \"<unknown>\",\n    \"state\": \"<unknown>\",\n    \"event_id\": \"<string>\",\n    \"run_id\": \"<string>\",\n    \"external_session_id\": \"<string>\",\n    \"parent_event_id\": \"<string>\",\n    \"links\": [\n      {\n        \"event_id\": \"<string>\",\n        \"run_id\": \"<string>\"\n      }\n    ],\n    \"external_artifact_id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"call_id\": \"<string>\",\n    \"stream_id\": \"<string>\",\n    \"sequence\": 123,\n    \"format\": \"<string>\",\n    \"timestamp\": \"2023-11-07T05:31:56Z\",\n    \"metadata\": \"<unknown>\"\n  },\n  \"run_id\": \"<string>\",\n  \"external_session_id\": \"<string>\",\n  \"role\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("whitecircle-version", "<whitecircle-version>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://eu.whitecircle.com/api/event")
  .header("whitecircle-version", "<whitecircle-version>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"environment_id\": \"<string>\",\n  \"event\": {\n    \"role\": \"<string>\",\n    \"content\": \"<unknown>\",\n    \"delta\": \"<unknown>\",\n    \"arguments\": \"<unknown>\",\n    \"output\": \"<unknown>\",\n    \"definition\": \"<unknown>\",\n    \"input\": \"<unknown>\",\n    \"instructions\": \"<unknown>\",\n    \"state\": \"<unknown>\",\n    \"event_id\": \"<string>\",\n    \"run_id\": \"<string>\",\n    \"external_session_id\": \"<string>\",\n    \"parent_event_id\": \"<string>\",\n    \"links\": [\n      {\n        \"event_id\": \"<string>\",\n        \"run_id\": \"<string>\"\n      }\n    ],\n    \"external_artifact_id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"call_id\": \"<string>\",\n    \"stream_id\": \"<string>\",\n    \"sequence\": 123,\n    \"format\": \"<string>\",\n    \"timestamp\": \"2023-11-07T05:31:56Z\",\n    \"metadata\": \"<unknown>\"\n  },\n  \"run_id\": \"<string>\",\n  \"external_session_id\": \"<string>\",\n  \"role\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.whitecircle.com/api/event")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["whitecircle-version"] = '<whitecircle-version>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"environment_id\": \"<string>\",\n  \"event\": {\n    \"role\": \"<string>\",\n    \"content\": \"<unknown>\",\n    \"delta\": \"<unknown>\",\n    \"arguments\": \"<unknown>\",\n    \"output\": \"<unknown>\",\n    \"definition\": \"<unknown>\",\n    \"input\": \"<unknown>\",\n    \"instructions\": \"<unknown>\",\n    \"state\": \"<unknown>\",\n    \"event_id\": \"<string>\",\n    \"run_id\": \"<string>\",\n    \"external_session_id\": \"<string>\",\n    \"parent_event_id\": \"<string>\",\n    \"links\": [\n      {\n        \"event_id\": \"<string>\",\n        \"run_id\": \"<string>\"\n      }\n    ],\n    \"external_artifact_id\": \"<string>\",\n    \"name\": \"<string>\",\n    \"call_id\": \"<string>\",\n    \"stream_id\": \"<string>\",\n    \"sequence\": 123,\n    \"format\": \"<string>\",\n    \"timestamp\": \"2023-11-07T05:31:56Z\",\n    \"metadata\": \"<unknown>\"\n  },\n  \"run_id\": \"<string>\",\n  \"external_session_id\": \"<string>\",\n  \"role\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "flagged": true,
  "policies": {
    "70289e06-9111-463e-b121-7247c2b7bfbd": {
      "flagged": true,
      "name": "No PII Sharing",
      "enabled_by_conditions": [
        {
          "id": "019f0000-0000-7000-8000-000000000001",
          "name": "EU users"
        }
      ]
    }
  },
  "event": {
    "event_id": "evt_user_001",
    "internal_event_id": "a1b2c3d4-e5f6-4890-abcd-ef1234567890",
    "status": "completed",
    "type": "message"
  },
  "run_id": "run_refund_123"
}

First Steps

Use Cases

Integrations

Events

Conditions

Artifacts

Policy

Metric

User

How It Works

Example Request

Request Overview

Event Payload

Content Fields

Response Overview

Conditions and Metadata

Parents and Links

Event Identity and Retries

Reference an Existing Event

Tool Output Example

Authorizations

Headers

Body

Response

​How It Works

​Example Request

​Request Overview

​Event Payload

​Content Fields

​Response Overview

​Conditions and Metadata

​Parents and Links

​Event Identity and Retries

​Reference an Existing Event

​Tool Output Example

Authorizations

Headers

Body

Response

How It Works

Example Request

Request Overview

Event Payload

Content Fields

Response Overview

Conditions and Metadata

Parents and Links

Event Identity and Retries

Reference an Existing Event

Tool Output Example