API Reference

Create Event

post
https://api.assembly.com/v1/events

This API endpoint creates a custom event in your workspace.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The event type you wish to log. Max 100 characters. The stored value is prefixed with customEvent. (see Notes above).

string
required

A human-readable description of the event. Max 500 characters.

json
required

A JSON object of key-value pairs describing the event. See Notes above for the expected shape.

string

The UUID of the user the event pertains to. Recommended for platform API callers so the event is attributed to the correct actor.

string

The UUID of the company the event pertains to. Required if actorId belongs to a client.

Response

Updated about 3 hours ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 3 hours ago