events

Creates, updates, deletes, gets or lists an events resource.

Overview

Name	events
Type	Resource
Id	vercel.user.events

Fields

The following fields are returned by SELECT queries:

list_user_events

Successful response.

Name	Datatype	Description
id	string	The unique identifier of the Event. (example: uev_bfmMjiMnXfnPbT97dGdpJbCN)
createdAt	number	Timestamp (in milliseconds) of when the event was generated.
entities	array	A list of "entities" within the event text. Useful for enhancing the displayed text with additional styling and links.
text	string	The human-readable text of the Event. (example: You logged in via GitHub)
user	object	Metadata for the User who generated the event.
userId	string	The unique identifier of the User who generated the event. (example: zTuNVUXEAvvnNN3IaqinkyMw)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_user_events	select	teamId	limit, since, until, types, userId	Retrieves a list of "events" generated by the User on Vercel. Events are generated when the User performs a particular action, such as logging in, creating a deployment, and joining a Team (just to name a few). When the teamId parameter is supplied, then the events that are returned will be in relation to the Team that was specified.
_list_user_events	exec	teamId	limit, since, until, types, userId	Retrieves a list of "events" generated by the User on Vercel. Events are generated when the User performs a particular action, such as logging in, creating a deployment, and joining a Team (just to name a few). When the teamId parameter is supplied, then the events that are returned will be in relation to the Team that was specified.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
teamId	string	The Team identifier or slug to perform the request on behalf of.
limit	number	Maximum number of items which may be returned.
since	string	Timestamp to only include items created since then.
types	string	Comma-delimited list of event "types" to filter the results by.
until	string	Timestamp to only include items created until then.
userId	string	When retrieving events for a Team, the userId parameter may be specified to filter events generated by a specific member of the Team.

SELECT examples

list_user_events

Retrieves a list of "events" generated by the User on Vercel. Events are generated when the User performs a particular action, such as logging in, creating a deployment, and joining a Team (just to name a few). When the teamId parameter is supplied, then the events that are returned will be in relation to the Team that was specified.

SELECT
id,
createdAt,
entities,
text,
user,
userId
FROM vercel.user.events
WHERE teamId = '{{ teamId }}' -- required
AND limit = '{{ limit }}'
AND since = '{{ since }}'
AND until = '{{ until }}'
AND types = '{{ types }}'
AND userId = '{{ userId }}'
;

Lifecycle Methods

_list_user_events

Retrieves a list of "events" generated by the User on Vercel. Events are generated when the User performs a particular action, such as logging in, creating a deployment, and joining a Team (just to name a few). When the teamId parameter is supplied, then the events that are returned will be in relation to the Team that was specified.

EXEC vercel.user.events._list_user_events 
@teamId='{{ teamId }}' --required, 
@limit='{{ limit }}', 
@since='{{ since }}', 
@until='{{ until }}', 
@types='{{ types }}', 
@userId='{{ userId }}'
;