URL Expired

The URL for this request expired after 30 days.

⚠️ Enterprise plan required: This endpoint is only available to workspaces on an enterprise plan. Requests from workspaces on any other plan return.401 Unauthorized with the message "Creating audit log events requires an enterprise plan."

Notes: Skip link to Notes:

Context

The context parameter is a JSON object of arbitrary key-value pairs that describe the event. Keys are strings; values can be strings, numbers, booleans, arrays, or nested objects. The object is stored as-is on the audit log entry and returned in the response.

For example, an event logging a testing session might include:

JSON

{
  "context": {
    "clientName": "ari",
    "topic": "testing"
  }
}

Event Type Prefix

The eventType value you submit is automatically prefixed withcustomEvent. in the stored event. For example, submitting eventType: "testing" results in a stored eventType of customEvent.testing.

eventType

string

required

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

eventDescription

string

required

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

actorId

string

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

companyId

string

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

context

json

required

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

``201 Created

Updatedabout 2 months ago

Did this page help you?

Yes

No

ShellNodeRubyPHPPython

xxxxxxxxxx

curl --request POST \

--url https://api.assembly.com/v1/events \

--header 'accept: application/json' \

--header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

``201 - Created

Updatedabout 2 months ago

Did this page help you?

Yes

No