Skip to content

Event Streaming

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

Download OpenAPI description
activities.openapi.json
activities.openapi.yaml
Languages
Servers
Sandbox environment
https://api.sbx.transmitsecurity.io/activities/v1/
Production environment (US)
https://api.transmitsecurity.io/activities/v1/
Production environment (EU)
https://api.eu.transmitsecurity.io/activities/v1/
Production environment (CA)
https://api.ca.transmitsecurity.io/risk/v1/
Production environment (AU)
https://api.au.transmitsecurity.io/risk/v1/

Start collecting events

Request

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 Fraud Prevention (risk).

Security
oauth2
Query
typeanyrequired

The event type to collect

Enum"cis""admin""verify""risk"
curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/activities/v1/activities/start-collect?type=cis' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Start collecting <TYPE> events.

Create event stream

Request

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 Fraud Prevention (risk).

Security
oauth2
Query
typeanyrequired

The event type to collect

Enum"cis""admin""verify""risk"
stream_idstringrequired

Event stream ID to collect events from

enrichmentboolean

Enrich the events with private data

curl -i -X PUT \
  'https://api.sbx.transmitsecurity.io/activities/v1/activities/stream?type=cis&stream_id=string&enrichment=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

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

Delete event stream

Request

Remove an event stream.

Security
oauth2
Query
typeanyrequired

The event type.

Enum"cis""admin""verify""risk"
stream_idstringrequired

The ID of the stream to delete

curl -i -X DELETE \
  'https://api.sbx.transmitsecurity.io/activities/v1/activities/stream?type=cis&stream_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

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

Collect events

Request

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 Fraud Prevention (risk).

Security
oauth2
Query
typeanyrequired

The event type to retrieve

Enum"cis""admin""verify""risk"
stream_idstringrequired

Event stream ID to collect events from

batch_sizeinteger[ 1 .. 1000 ]

The maximum number of events to return

curl -i -X POST \
  'https://api.sbx.transmitsecurity.io/activities/v1/activities/collect?type=cis&stream_id=string&batch_size=1' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Bodyapplication/jsonArray [
One of:
activitystringrequired

The activity performed by the user

Example: "risk_recommendation"
app_idstringrequired

The unique ID of the application that generated the audit event

Example: "Abt5xRVuE9bA4YFT9pQpC"
ipstringrequired

The IP address of the user

Example: "1.1.1.1"
timestampstring(date-time)required

The date and time the event occurred (ISO 8601)

Example: "2022-12-01T01:20:23.000Z"
user_agentstringrequired

The user agent string of the user's device

Example: "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_idstringrequired

The unique ID of the user who performed the activity

Example: "8XrdnAMJcMD8RhVMjDipa"
additionalParamsobjectrequired
One of:

The additional parameters of the cis activity

additionalParams.​customDataUsedboolean

Indicates whether custom data was used during user creation

]
Response
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

Request

Stop collecting events and delete all event streams

Security
oauth2
Query
typeanyrequired

The event type to stop collecting

Enum"cis""admin""verify""risk"
curl -i -X DELETE \
  'https://api.sbx.transmitsecurity.io/activities/v1/activities/stop-collect?type=cis' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Stopped collecting <TYPE> events.