# Event routes

URL: /code/api/event · Id: `page:code/api/event`

> Every Event Verb as an api.sb route, with its inputs, result, refusals and an example.

Reference for [Event](/business/nouns/event).

### Event.create
Creates an Event. [Verb page](/business/nouns/event/create?interface=api).

```text
POST /{namespace}/events
```

Body, as JSON: the inputs. Emits `Event.created`.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | `string` | Yes | The Noun and the event form of its Verb, such as `Order.placed`. |
| `at` | `datetime` | Yes | When it happened. |
| `data` | `json` | No | The Thing as the Action left it. |
| `seq` | `integer` | No | Its position in the namespace, one more than the Event before; any seq is a cursor into the history. |
| `action` | [Action](/business/nouns/action) | No | A completed Action emits its Events, which Triggers, Watches and Metrics read. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `event` | [Event](/business/nouns/event) | Yes | The Event. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl -X POST https://api.sb/leaseline.app/events \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline","at":"2026-10-22T12:00:00Z"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "event": {
    "$id": "https://api.sb/leaseline.app/events/evt_GR8HraK1o0",
    "$type": "Event",
    "name": "Leaseline",
    "at": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Event.create",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```

### Event.get
Returns one Event by id. [Verb page](/business/nouns/event/get?interface=api).

```text
GET /{namespace}/events/{id}
```

Path: `id`. Query: the other inputs. Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string` | Yes | The id of the Event. |
| `at` | `string` | No | A time or Version name: the record as it stood then. Unset: as it stands now. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `event` | [Event](/business/nouns/event) | Yes | The Event. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl https://api.sb/leaseline.app/events/evt_9wPvd8R17L \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Event",
  "$id": "https://api.sb/leaseline.app/events/evt_9wPvd8R17L",
  "event": {
    "$id": "https://api.sb/leaseline.app/events/evt_9wPvd8R17L",
    "$type": "Event",
    "name": "Invoice.billed",
    "at": "2026-10-01T07:00:00Z"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/events/evt_9wPvd8R17L",
    "up": "https://api.sb/leaseline.app/events"
  }
}
```

### Event.list
Returns Events, newest first, one page at a time. [Verb page](/business/nouns/event/list?interface=api).

```text
GET /{namespace}/events
```

Query: the inputs. Reads only: it emits no Event.

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `limit` | `integer` | No | At most this many records, up to 100. The default is 20. |
| `after` | `string` | No | The cursor from the previous page. |
| `where` | `string` | No | A filter over the properties, such as `paidAt = null and total.amount > 500`. |
| `sort` | `string` | No | Properties to sort by, comma-separated; a leading minus sorts descending. |
| `total` | `boolean` | No | True adds the match count as `meta.total`, exact up to 10,000 matches and estimated above. |
| `facets` | `string` | No | Properties to count by value, comma-separated, returned as `meta.facets`. |
| `fields` | `string` | No | Properties to return on each record, comma-separated; `$id` and `$type` always return. |
| `include` | `string` | No | Related records to embed in place of their URLs, comma-separated. |
| `depth` | `integer` | No | How many levels of related records to embed. The default is 1. |
| `q` | `string` | No | Words to match across the text properties, ranked by relevance. |
| `match` | `string` | No | Ranks the search by `words`, or `meaning`; words is the default. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `events` | list of [Event](/business/nouns/event) | Yes | One page of Events. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl "https://api.sb/leaseline.app/events?limit=20" \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY"
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "$type": "Event",
  "events": [
    {
      "$id": "https://api.sb/leaseline.app/events/evt_9wPvd8R17L",
      "$type": "Event",
      "name": "Invoice.billed",
      "at": "2026-10-01T07:00:00Z"
    }
  ],
  "meta": {
    "limit": 20,
    "after": "evt_9wPvd8R17L"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/events?limit=20",
    "next": "https://api.sb/leaseline.app/events?after=evt_9wPvd8R17L"
  }
}
```

### Event.capture
Capture records an Event from a Site, App or API call that no Verb emits, such as a page view or a click. [Verb page](/business/nouns/event/capture?interface=api).

```text
POST /{namespace}/events/capture
```

Body, as JSON: the inputs. Emits [`Event.captured`](/business/events/Event.captured).

**Inputs**

| Input | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | `string` | Yes | The Event name, `Noun.pastTense`. |
| `data` | `json` | No | The Event’s properties. |
| `visitor` | [Visitor](/business/nouns/visitor) | No | The Visitor it happened to, when the person is not known. |

**Returns**

| Output | Type | Required | Description |
| --- | --- | --- | --- |
| `event` | [Event](/business/nouns/event) | Yes | The captured Event. |

**Refuses when**

| Check | Error | Fix | Then call |
| --- | --- | --- | --- |
| The key is valid, but its scopes do not allow this operation. | [`forbidden`](/code/api/errors/forbidden) | Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them. | None. |

**Example**

```bash
curl -X POST https://api.sb/leaseline.app/events/capture \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Leaseline"}'
```

```json
{
  "api": "https://api.sb/leaseline.app",
  "event": {
    "$id": "https://api.sb/leaseline.app/events/evt_GR8HraK1o0",
    "$type": "Event",
    "name": "Leaseline",
    "at": "2026-10-22T12:00:00Z"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Event.capture",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}
```