events

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

Overview

Name	events
Type	Resource
Id	vercel.deployments.events

Fields

The following fields are returned by SELECT queries:

get_deployment_events

A stream of jsonlines where each line is a deployment log item.
Array of deployment logs for the provided query.

Name	Datatype	Description

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_deployment_events	select	idOrUrl, teamId	direction, follow, limit, name, since, until, statusCode, delimiter, builds	Get the build logs of a deployment by deployment ID and build ID. It can work as an infinite stream of logs or as a JSON endpoint depending on the input parameters.

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
idOrUrl	string	The unique identifier or hostname of the deployment.
teamId	string	The Team identifier or slug to perform the request on behalf of.
builds	number
delimiter	number
direction	string	Order of the returned events based on the timestamp.
follow	number	When enabled, this endpoint will return live events as they happen.
limit	number	Maximum number of events to return. Provide -1 to return all available logs.
name	string	Deployment build ID.
since	number	Timestamp for when build logs should be pulled from.
statusCode		HTTP status code range to filter events by.
until	number	Timestamp for when the build logs should be pulled up until.

SELECT examples

get_deployment_events

Get the build logs of a deployment by deployment ID and build ID. It can work as an infinite stream of logs or as a JSON endpoint depending on the input parameters.

SELECT
*
FROM vercel.deployments.events
WHERE idOrUrl = '{{ idOrUrl }}' -- required
AND teamId = '{{ teamId }}' -- required
AND direction = '{{ direction }}'
AND follow = '{{ follow }}'
AND limit = '{{ limit }}'
AND name = '{{ name }}'
AND since = '{{ since }}'
AND until = '{{ until }}'
AND statusCode = '{{ statusCode }}'
AND delimiter = '{{ delimiter }}'
AND builds = '{{ builds }}'
;