Event Streaming

Download OpenAPI specification:Download

Stay accountable and keep track of activity by streaming platform events.

Get user activitiesDeprecated

Retrieve a list of user activities that occurred within the last 30 days. For registered users, Transmit captures events such as password resets, failed user logins, or registering biometrics

SecurityOAuth2: oauth2

Request

query Parameters

batch_size

integer [ 1 .. 1000 ]

The maximum number of user activities to return

Responses

200

OK

401

Unauthorized

500

Internal server error

get/activities/user

Request samples

Response samples

200

application/json

[{"activity": "risk_recommendation",
"app_id": "Abt5xRVuE9bA4YFT9pQpC",
"ip": "1.1.1.1",
"timestamp": "2022-12-01T01:20:23.000Z",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.1 Safari/605.1.15",
"user_id": "8XrdnAMJcMD8RhVMjDipa"
}
]

Get admin activitiesDeprecated

Retrieve a list of admin activities that occurred within the last 30 days. Transmit reports events such as creating or deleting an admin, creating a management app, or updating audit settings

SecurityOAuth2: oauth2

Request

query Parameters

batch_size

integer [ 1 .. 1000 ]

The maximum number of admin activities to return

Responses

200

OK

401

Unauthorized

500

Internal server error

get/activities/admin

Request samples

Response samples

200

application/json

[{"activity": "admin_login",
"actor_id": "I9ZHzI210K31O8CQpadIW",
"actor_type": "user",
"ip": "1.1.1.1",
"target_resource_id": "admin-portal",
"target_resource_type": "app",
"timestamp": "2022-12-01T01:20:23.000Z",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/108.0.0.0 Safari/537.36"
}
]

Start collecting events

Start collecting events of a specific type. Transmit can report events related to authentication and user management (cis), management apps and settings (admin), identity verifications (verify), and detection and response (risk).

SecurityOAuth2: oauth2

Request

query Parameters

type

required

any

The event type to collect

Enum: "cis" "admin" "verify" "risk"

Responses

200

Start collecting <TYPE> events.

400

Bad request

401

Unauthorized

409

Already exists

500

Internal server error

put/activities/start-collect

Request samples

Create event stream

Create an event stream for a specific type of events. Transmit can report events related to authentication and user management (cis), management apps and settings (admin), identity verifications (verify), and detection and response (risk).

SecurityOAuth2: oauth2

Request

query Parameters

type required	any The event type to collect Enum: "cis" "admin" "verify" "risk"
stream_id required	string Event stream ID to collect events from
enrichment	boolean Enrich the events with private data
filter	string Filter the events in the stream
ordering	boolean Order the events in the stream by timestamp
retention	integer [ 1 .. 7 ] Time retention (days) for the events in the stream

Responses

200

Events stream: <STREAM_ID>, with <TYPE> events, was created successfully.

400

Bad request

401

Unauthorized

403

Cannot handle request without performing start collect action first.

406

stream_id parameter is required and must be a continuous non-empty string.

429

Tenant has reached the maximum number of event streams.

500

Internal server error

put/activities/stream

Request samples

Delete event stream

Remove an event stream.

SecurityOAuth2: oauth2

Request

query Parameters

type required	any The event type. Enum: "cis" "admin" "verify" "risk"
stream_id required	string The ID of the stream to delete

Responses

200

Events stream: <STREAM_ID>, with <TYPE> events, was deleted successfully.

400

Bad request

401

Unauthorized

403

Cannot handle request without performing start collect action first.

404

Stream not found.

406

stream_id parameter is required and must be a continuous non-empty string.

500

Internal server error

delete/activities/stream

Request samples

Collect events

Retrieve a list of events, according to the type requested, that occurred within the last day. Transmit can report events related to authentication and user management (cis), management apps and settings (admin), identity verifications (verify), and detection and response (risk).

SecurityOAuth2: oauth2

Request

query Parameters

type required	any The event type to retrieve Enum: "cis" "admin" "verify" "risk"
stream_id required	string Event stream ID to collect events from
batch_size	integer [ 1 .. 1000 ] The maximum number of events to return

Responses

201

OK

401

Unauthorized

403

Cannot handle request without performing start collect action first.

404

Stream not found.

406

stream_id parameter is required and must be a continuous non-empty string.

500

Internal server error

post/activities/collect

Request samples

Response samples

201

application/json

[{"activity": "risk_recommendation",
"app_id": "Abt5xRVuE9bA4YFT9pQpC",
"ip": "1.1.1.1",
"timestamp": "2022-12-01T01:20:23.000Z",
"user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/16.1 Safari/605.1.15",
"user_id": "8XrdnAMJcMD8RhVMjDipa",
"additionalParams": { }
}
]

Stop collecting events

Stop collecting events and delete all event streams

SecurityOAuth2: oauth2

Request

query Parameters

type

required

any

The event type to stop collecting

Enum: "cis" "admin" "verify" "risk"

Responses

200

Stopped collecting <TYPE> events.

400

Bad request

401

Unauthorized

403

Cannot handle request without performing start collect action first.

500

Internal server error

delete/activities/stop-collect

Request samples