Skip to main content

​
The Event Object

Events represent activities and actions within your application. They can trigger webhooks and are used for audit logging.

​
Attributes

​
string
required
Unique identifier for the eventExample: evt_123
​
string
required
Application ID where the event occurred
​
string
required
Event type identifierExample: user.created
​
string
required
Event category for grouping related eventsExample: user
​
string
Originating controller that triggered the eventExample: UsersController
​
string
Originating action that triggered the eventExample: create
​
string
ID of the user associated with this event
​
object
required
Event payload containing relevant dataExample: { "user_id": "usr_123", "email": "user@example.com" }
​
object
Additional metadata about the eventExample: { "ip_address": "192.168.1.1", "user_agent": "Mozilla/5.0" }
​
object
Captured request parameters
​
string
Optional note or description
​
string
IP address where the event originatedExample: 192.168.1.1
​
string
Browser or client user agent stringExample: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7)
​
string
required
ISO 8601 timestamp when the event was created
​
string
required
ISO 8601 timestamp when the event was last updated

​
Example Event Object