---
sidebar:
  hidden: true
title: roboto.domain.platform_events.samples
---
One fixed scenario, rendered as a platform event of every type.

Every sample envelope and every sample entity record draws its ids from the constants below, so samples of different event types agree with each other.

## Module Contents

### SAMPLE_ACTION_DIGEST

```python
roboto.domain.platform_events.samples.SAMPLE_ACTION_DIGEST = 'sha256:9f1c2e7b4a0d8c6f3e5b1a7d2c4f8e6a0b3d5c7e9f1a2b4c6d8e0f2a4b6c8d0e'
```

`from roboto.domain.platform_events import SAMPLE_ACTION_DIGEST`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L42-L42)

### SAMPLE_ACTION_NAME

```python
roboto.domain.platform_events.samples.SAMPLE_ACTION_NAME = 'ros-ingest'
```

`from roboto.domain.platform_events import SAMPLE_ACTION_NAME`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L41-L41)

### SAMPLE_API_DOMAIN

```python
roboto.domain.platform_events.samples.SAMPLE_API_DOMAIN = 'api.roboto.ai'
```

`from roboto.domain.platform_events import SAMPLE_API_DOMAIN`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L30-L30)

### SAMPLE_CHANGESET

```python
roboto.domain.platform_events.samples.SAMPLE_CHANGESET
```

`from roboto.domain.platform_events import SAMPLE_CHANGESET`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L45-L49)

### SAMPLE_DATASET_ID

```python
roboto.domain.platform_events.samples.SAMPLE_DATASET_ID = 'ds_7h2k9m4qxp3w'
```

`from roboto.domain.platform_events import SAMPLE_DATASET_ID`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L34-L34)

### SAMPLE_EVENT_ID

```python
roboto.domain.platform_events.samples.SAMPLE_EVENT_ID = 'ev_7g3n5kq2wxrd'
```

`from roboto.domain.platform_events import SAMPLE_EVENT_ID`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L35-L35)

### SAMPLE_FILE_ID

```python
roboto.domain.platform_events.samples.SAMPLE_FILE_ID = 'fl_q8v2n6ty4mcs'
```

`from roboto.domain.platform_events import SAMPLE_FILE_ID`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L36-L36)

### SAMPLE_FILE_VERSION

```python
roboto.domain.platform_events.samples.SAMPLE_FILE_VERSION = 2
```

`from roboto.domain.platform_events import SAMPLE_FILE_VERSION`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L37-L37)

### SAMPLE_INVOCATION_ID

```python
roboto.domain.platform_events.samples.SAMPLE_INVOCATION_ID = 'iv_2x9pd7wk5rhf'
```

`from roboto.domain.platform_events import SAMPLE_INVOCATION_ID`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L38-L38)

### SAMPLE_ORG_ID

```python
roboto.domain.platform_events.samples.SAMPLE_ORG_ID = 'og_k3m8w2rq7nxd'
```

`from roboto.domain.platform_events import SAMPLE_ORG_ID`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L31-L31)

### SAMPLE_SESSION_ID

```python
roboto.domain.platform_events.samples.SAMPLE_SESSION_ID = 'se_m4t7c1zq9bvn'
```

`from roboto.domain.platform_events import SAMPLE_SESSION_ID`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L39-L39)

### SAMPLE_TAGS_ADDED

```python
roboto.domain.platform_events.samples.SAMPLE_TAGS_ADDED = ['validated', 'nightly']
```

`from roboto.domain.platform_events import SAMPLE_TAGS_ADDED`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L44-L44)

### SAMPLE_TIME

```python
roboto.domain.platform_events.samples.SAMPLE_TIME
```

`from roboto.domain.platform_events import SAMPLE_TIME`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L25-L25)

The instant every sample event and record is dated from, so samples are stable across calls.

### SAMPLE_TRANSACTION_ID

```python
roboto.domain.platform_events.samples.SAMPLE_TRANSACTION_ID = 'tx_5jw8r3ne2kpq'
```

`from roboto.domain.platform_events import SAMPLE_TRANSACTION_ID`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L40-L40)

### SAMPLE_TRIGGER_ID

```python
roboto.domain.platform_events.samples.SAMPLE_TRIGGER_ID = 'tr_3nq7wk2mx9pd'
```

`from roboto.domain.platform_events import SAMPLE_TRIGGER_ID`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L32-L32)

### SAMPLE_USER

```python
roboto.domain.platform_events.samples.SAMPLE_USER = 'maria.chen@acme-robotics.com'
```

`from roboto.domain.platform_events import SAMPLE_USER`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L33-L33)

### sample_platform_event()

```python
def roboto.domain.platform_events.samples.sample_platform_event(
    event_type: roboto.domain.platform_events.events.PlatformEventType,
) -> roboto.domain.platform_events.events.PlatformEvent
```

`from roboto.domain.platform_events import sample_platform_event`

[Source](https://github.com/roboto-ai/roboto-python-sdk/blob/main/src/roboto/domain/platform_events/samples.py#L97-L120)

A valid, fully populated event of `event_type` from the sample scenario.

**Parameters**

- **event_type** (`roboto.domain.platform_events.events.PlatformEventType`)

**Returns**

- `roboto.domain.platform_events.events.PlatformEvent`