Orishare
Api

List events (newest first)

GET
/events

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Query Parameters

limit?integer
Range1 <= value <= 200
Default50
cursor?string
Lengthlength <= 2048
customer_id?string
name?string
since?string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/events"
{  "data": [    {      "id": "string",      "client_event_id": "string",      "name": "string",      "customer_id": "string",      "occurred_at": "string",      "received_at": "string",      "properties": {        "property1": null,        "property2": null      },      "mode": "async",      "late": true,      "status": "accepted",      "execution_id": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Send one event or a batch; async by default, `mode: sync` evaluates inline (secret keys)

POST
/events

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/events" \  -H "Content-Type: application/json" \  -d '{    "name": "content.purchased",    "customer_id": "cust_123",    "mode": "sync",    "properties": {      "content_id": "book_42",      "price_cents": 1499    }  }'
{  "status": "accepted",  "id": "string",  "customer_id": "string",  "late": true,  "fallback": true,  "execution_id": "string",  "effects": [    null  ],  "trace": null,  "error": {    "code": "string",    "message": "string",    "param": "string"  }}

One event with its evaluation status

GET
/events/{id}

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/events/string"
{  "id": "string",  "client_event_id": "string",  "name": "string",  "customer_id": "string",  "occurred_at": "string",  "received_at": "string",  "properties": {    "property1": null,    "property2": null  },  "mode": "async",  "late": true,  "status": "accepted",  "execution_id": "string"}

Plan and trace of an evaluated event

GET
/events/{id}/execution

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/events/string/execution"
{  "id": "string",  "event_id": "string",  "customer_id": "string",  "version_set": "string",  "matched_rules": 0,  "plan": [    null  ],  "trace": null,  "created_at": "string"}

Observed event names with property types and samples

GET
/event_definitions

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/event_definitions"
{  "data": [    {      "id": "string",      "name": "string",      "observed_schema": {        "property1": null,        "property2": null      },      "confirmed_schema": {        "property1": null,        "property2": null      },      "description": "string",      "samples": [        null      ],      "event_count": 0,      "client_allowed": true,      "first_seen_at": "string",      "last_seen_at": "string",      "version": 0,      "updated_at": "string"    }  ],  "next_cursor": "string",  "has_more": true}

Describe an event, confirm its schema, or allow it from publishable keys

PATCH
/event_definitions/{id}

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/event_definitions/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "id": "string",  "name": "string",  "observed_schema": {    "property1": null,    "property2": null  },  "confirmed_schema": {    "property1": null,    "property2": null  },  "description": "string",  "samples": [    null  ],  "event_count": 0,  "client_allowed": true,  "first_seen_at": "string",  "last_seen_at": "string",  "version": 0,  "updated_at": "string"}

Re-run an accepted, failed or poison event with its original identity

POST
/events/{id}/retry

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/events/string/retry"
{  "execution_id": "string",  "status": "evaluated",  "plan": [    null  ],  "trace": null,  "effects": [    null  ]}

Events parked after repeated evaluator failures

GET
/poison_events

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Query Parameters

include_resolved?string

Value in

  • "true"
  • "false"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/poison_events"
{  "data": [    {      "event_id": "string",      "event_name": "string",      "customer_id": "string",      "attempts": 0,      "last_error": "string",      "last_error_at": "string",      "resolved_at": "string",      "resolution": "retried"    }  ],  "next_cursor": "string",  "has_more": true}

Give up on a parked event (audited); it stays failed and never re-runs

POST
/poison_events/{id}/discard

Authorization

bearer
AuthorizationBearer <token>

Secret key (osk_…), publishable key (opk_…) or personal access token (opat_…).

In: header

Path Parameters

id*string
Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/poison_events/string/discard"
Empty

Customers

Customers, aliases, attributes and the aggregated state view.

Ledger

Currencies, manual adjustments, entries and balances.