write-events

Write Events

Write one or more events to an EventSourcingDB instance.

Configuration

Read configuration from environment variables:

echo "ESDB_URL: ${ESDB_URL:-http://localhost:3000}"
echo "ESDB_API_TOKEN: ${ESDB_API_TOKEN:-(not set)}"

• Use ESDB_URL if set, otherwise default to http://localhost:3000.
• If ESDB_API_TOKEN is not set, use AskUserQuestion to ask the user for the API token.

Request

curl -s -i -X POST \
  -H "authorization: Bearer ${ESDB_API_TOKEN}" \
  -H "content-type: application/json" \
  -d '<REQUEST_BODY>' \
  "${ESDB_URL:-http://localhost:3000}/api/v1/write-events"

Request Body

{
  "events": [
    {
      "source": "<source-url>",
      "subject": "/<subject-path>",
      "type": "<reverse.domain.event-type>",
      "data": { ... }
    }
  ],
  "preconditions": [
    {
      "type": "<precondition-type>",
      "payload": { ... }
    }
  ]
}

The preconditions field is optional. Available precondition types:

• isSubjectPristine – Subject must have no events yet.

  { "type": "isSubjectPristine", "payload": { "subject": "/books/42" } }
  

• isSubjectPopulated – Subject must already have events.

  { "type": "isSubjectPopulated", "payload": { "subject": "/books/42" } }
  

• isSubjectOnEventId – Optimistic locking: last event must match given ID.

  { "type": "isSubjectOnEventId", "payload": { "subject": "/books/42", "eventId": "0" } }
  

• isEventQlQueryTrue – Custom condition via EventQL query.

  { "type": "isEventQlQueryTrue", "payload": { "query": "FROM e IN events WHERE e.data.title == 'Some Title' PROJECT INTO COUNT() == 0" } }
  

Example

curl -s -i -X POST \
  -H "authorization: Bearer ${ESDB_API_TOKEN}" \
  -H "content-type: application/json" \
  -d "{
    \"events\": [
      {
        \"source\": \"https://example.com\",
        \"subject\": \"/books/42\",
        \"type\": \"io.example.book-acquired\",
        \"data\": {
          \"title\": \"2001 - A Space Odyssey\",
          \"author\": \"Arthur C. Clarke\"
        }
      }
    ]
  }" \
  "${ESDB_URL:-http://localhost:3000}/api/v1/write-events"

Response

The response is JSON containing an array of stored events.

A precondition failure returns HTTP 409 Conflict.

Conventions

• Subjects always start with / (e.g., /books/42, /readers/23).
• Event types use reverse domain notation (e.g., io.eventsourcingdb.library.book-acquired).
• Event IDs are strings, even if they look numeric (e.g., "0", "42").