List events

List lifecycle events recorded with or without webhooks. Events and their deliveries expire according to the plan retention deadline. Historical notifications recorded before the event log remain available through Notifications.

GET

/events

Authorization

header

string

required

Enter the project access token with the Bearer prefix, e.g. "Bearer project_access_token"

Query Parameters

object_id

string

Filter by the primary or a related resource ID, including retained associations after resource deletion.

events

string[]

Filter by events

Available options:

job.createdjob.completedjob.failedjob.cancelledsource.createdsource.deletedupload.createdupload.completedupload.failedupload.expiredasset.createdasset.readyasset.playback_readyasset.failedasset.expiredasset.deletedasset.output.createdasset.output.readyasset.output.failedasset.output.deletedworkflow_run.createdworkflow_run.completedworkflow_run.failedworkflow_run.cancelledtranscoding.createdtranscoding.readytranscoding.failedtranscoding.cancelledtranscoding.expiredtranscoding.deletedthumbnail.createdthumbnail.readythumbnail.failedthumbnail.expiredthumbnail.deleted

offset

default: 0

integer

Pagination offset

Required range: x >= 0

limit

default: 100

integer

Pagination limit (max 100)

Required range: 1 <= x <= 100

created.gte

integer

epoch

Filter by creation date greater than or equal (UNIX epoch time)

Required range: x >= 0

Examples:

1764238404

created.lte

integer

epoch

Filter by creation date less than or equal (UNIX epoch time)

Required range: x >= 0

Examples:

1764238404

created.sort

default: "desc"

string

Sort by creation date (asc/desc)

Available options:

ascdesc

Responses

application/json

data

object[]

required

Events ordered by occurrence time and ID.

created_at

string

date-time

required

Time the event occurred.

delivery_count

integer

required

Number of retained webhook delivery attempts.

delivery_status

string

required

Summary of the latest retained attempt for each webhook. none means no retained attempts; pending means at least one latest attempt is awaiting delivery; failed means at least one latest attempt failed and none are pending; delivered means all latest attempts succeeded. Earlier failures superseded by successful retries do not mark the event failed.

Available options:

nonependingdeliveredfailed

event

string

required

Available options:

Examples:

asset.playback_ready

expires_at

string

date-time

required

Retention deadline set from the project team plan when the event was recorded. Deliveries and retries share this deadline.

string

required

Unique event ID.

Examples:

evt_2G6MJiNz71bHQGNzGwKx5cJwPFS

object_id

string

required

ID of the resource that caused this event.

payload

string

required

Immutable JSON event envelope. Its ID is the event ID; webhook delivery envelopes retain their notification IDs. Signed links in historical snapshots may have expired.

related_object_ids

string[]

required

Related resource IDs retained independently of resource deletion.

deliveries

object[]

First 100 delivery attempts, oldest first; included on retrieval. List notifications with event_id to paginate all attempts.

created_at

string

date-time

required

Timestamp when the notification was created

Examples:

2025-01-01T12:00:00Z

event

string

required

Type of event that triggered this notification

Available options:

Examples:

asset.playback_ready

string

required

Unique identifier of the notification

Examples:

notf_2G6MJiNz71bHQGNzGwKx5cJwPFS

object_id

string

required

ID of the object that triggered this notification

Examples:

ast_2G6MJiNz71bHQGNzGwKx5cJwPFS

payload

string

required

JSON payload that was sent to the webhook endpoint

Examples:

{"id":"notf_2G6MJiNz71bHQGNzGwKx5cJwPFS""event":"asset.playback_ready""date":"2025-01-01T12:00:00Z""data":{"asset":{"id":"ast_2G6MJiNz71bHQGNzGwKx5cJwPFS""status":"preparing""playback_ready":true}}}

webhook

object

required

Webhook endpoint configuration that received this notification

event_id

string

Originating event ID, when recorded by the event log.

response_status_code

integer

HTTP status code received from the webhook endpoint

Examples:

200

limit

integer

required

Limit indicates the maximum number of items in the current response

offset

integer

required

Offset indicates the offset of the first item in the current response

status

"success"

string

required

Status indicates the response status "success"

total

integer

required

Total indicates the total number of items

application/json

error

object

required

status

"error"

string

required

Status indicates the response status "error"

Invalid filters.

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Authentication error: invalid token or subscription inactive

application/json

error

object

required

Error response details

status

"error"

string

required

Status indicates the response status "error"

Rate limit exceeded

import Chunkify from '@chunkify/chunkify'; const client = new Chunkify({ projectAccessToken: 'My Project Access Token', }); // Automatically fetches more pages as needed. for await (const event of client.events.list()) { console.log(event.id); }

from chunkify import Chunkify client = Chunkify( project_access_token="My Project Access Token", ) # Automatically fetches more pages as needed. for event in client.events.list(): print(event.id)

<?php use Chunkify\Client; $client = new Client( projectAccessToken: 'My Project Access Token', ); // Automatically fetches more pages as needed. foreach ($client->events->list()->pagingEachItem() as $event) { var_dump($event->id); }

package main import ( "context" "fmt" "github.com/chunkifydev/chunkify-go" "github.com/chunkifydev/chunkify-go/option" ) func main() { client := chunkify.NewClient( option.WithProjectAccessToken("My Project Access Token"), ) page, err := client.Events.List( context.TODO(), chunkify.EventListParams{}, ) if err != nil { panic(err.Error()) } // Loop through the pages and print the events IDs for page != nil { for _, event := range page.Data { fmt.Printf("%+v\n", event.ID) } page, err = page.GetNextPage() if err != nil { panic(err.Error()) } } }

{ "data": [ { "created_at": "<string>", "delivery_count": "<integer>", "delivery_status": "none", "event": "asset.playback_ready", "expires_at": "<string>", "id": "evt_2G6MJiNz71bHQGNzGwKx5cJwPFS", "object_id": "<string>", "payload": "<string>", "related_object_ids": [ "<string>" ] } ], "limit": "<integer>", "offset": "<integer>", "status": "success", "total": "<integer>" }