GET /v3/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.

Servers

Query parameters

Name Type Required Description
userId String No

Deprecated. Use principalId instead. If principalId and userId both exist, principalId will be used.

projectIds String No

Comma-delimited list of project IDs to filter the results by.

withPayload String No

When set to true, the response will include the payload field for each event.

teamId String No

The Team identifier to perform the request on behalf of.

limit Number No

Maximum number of items which may be returned.

types String No

Comma-delimited list of event "types" to filter the results by.

slug String No

The Team slug to perform the request on behalf of.

until String No

Timestamp to only include items created until then.

since String No

Timestamp to only include items created since then.

principalId String No

When retrieving events for a Team, the principalId parameter may be specified to filter events generated by a specific principal.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.