Documentation / API Reference / Retrieve an event
Retrieve an event Retrieve a retained event, its frozen payload, related resources, and up to 100 delivery attempts. No webhook configuration is required.
Authorization Authorization
header
string
required
Enter the project access token with the Bearer prefix, e.g. "Bearer project_access_token"
Path Parameters
Responses 200 401 404 429
application/json Show data properties
created_at
string
date-time
required
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
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
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.
Examples:
evt_2G6MJiNz71bHQGNzGwKx5cJwPFS
ID of the resource that caused this event.
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.
First 100 delivery attempts, oldest first; included on retrieval. List notifications with event_id to paginate all attempts.
Show deliveries properties
created_at
string
date-time
required
Timestamp when the notification was created
Examples:
2025-01-01T12:00:00Z
Type of event that triggered this notification
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
Examples:
asset.playback_ready
Unique identifier of the notification
Examples:
notf_2G6MJiNz71bHQGNzGwKx5cJwPFS
ID of the object that triggered this notification
Examples:
ast_2G6MJiNz71bHQGNzGwKx5cJwPFS
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 endpoint configuration that received this notification
Show webhook properties
Whether the webhook is currently enabled
Array of event types this webhook subscribes to
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
Examples:
[asset.playback_ready asset.failed]
Unique identifier of the webhook
Examples:
wh_2G6MJiNz71bHQGNzGwKx5cJwPFS
ID of the project this webhook belongs to
Examples:
proj_2G6MJiNz71bHQGNzGwKx5cJwPFS
URL where webhook events will be sent
Examples:
https://example.com/webhook
Originating event ID, when recorded by the event log.
response_status_code
integer
HTTP status code received from the webhook endpoint
status
"success"
string
required
Status indicates the response status "success"
OK
application/json Error response details
Show error properties
Code is the HTTP status code
Message is a human-readable error description
Examples:
Authentication error: invalid token or subscription inactive
type
"AuthenticationError"
string
required
Type indicates the error category
Available options:
AuthenticationError
status
"error"
string
required
Status indicates the response status "error"
Authentication error: invalid token or subscription inactive
application/json Error response details
Show error properties
Code is the HTTP status code
Message is a human-readable error description
Examples:
Ressource not found
type
"NotFoundError"
string
required
Type indicates the error category
Available options:
NotFoundError
status
"error"
string
required
Status indicates the response status "error"
Resource not found
application/json Error response details
Show error properties
Code is the HTTP status code
Message is a human-readable error description
Examples:
Rate limit exceeded
type
"TooManyRequestsError"
string
required
Type indicates the error category
Available options:
TooManyRequestsError
status
"error"
string
required
Status indicates the response status "error"
Rate limit exceeded
# Retrieve an event
> Retrieve a retained event, its frozen payload, related resources, and up to 100 delivery attempts. No webhook configuration is required.
```json
{
"path": "/events/{eventId}",
"method": "get",
"schema": {
"description": "Retrieve a retained event, its frozen payload, related resources, and up to 100 delivery attempts. No webhook configuration is required.",
"operationId": "getEvent",
"parameters": [
{
"description": "Event ID to retrieve.",
"in": "path",
"name": "eventId",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"content": {
"application/json": {
"example": {
"data": {
"created_at": "2026-09-18T08:00:00Z",
"deliveries": [],
"delivery_count": 0,
"delivery_status": "none",
"event": "upload.expired",
"expires_at": "2026-09-25T08:00:00Z",
"id": "evt_example",
"object_id": "upl_example",
"payload": "{\"id\":\"evt_example\",\"event\":\"upload.expired\",\"date\":\"2026-09-18T08:00:00Z\",\"data\":{\"upload\":{\"id\":\"upl_example\",\"status\":\"expired\"}}}",
"related_object_ids": [
"upl_example"
]
},
"status": "success"
},
"schema": {
"$ref": "#/components/schemas/EventResponse"
}
}
},
"description": "OK"
},
"401": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrorAuthentication"
}
}
},
"description": "Authentication error: invalid token or subscription inactive"
},
"404": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrorNotFound"
}
}
},
"description": "Resource not found"
},
"429": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResponseErrorTooManyRequests"
}
}
},
"description": "Rate limit exceeded"
}
},
"security": [
{
"ProjectAccessToken": []
}
],
"summary": "Retrieve an event",
"tags": [
"Events"
],
"x-codeSamples": [
{
"lang": "JavaScript",
"source": "import Chunkify from '@chunkify/chunkify';\n\nconst client = new Chunkify({\n projectAccessToken: 'My Project Access Token',\n});\n\nconst event = await client.events.retrieve('eventId');\n\nconsole.log(event);"
},
{
"lang": "Python",
"source": "from chunkify import Chunkify\n\nclient = Chunkify(\n project_access_token=\"My Project Access Token\",\n)\nevent = client.events.retrieve(\n \"eventId\",\n)\nprint(event)"
},
{
"lang": "php",
"source": "\u003c?php\n\nuse Chunkify\\Client;\n\n$client = new Client(\n projectAccessToken: 'My Project Access Token',\n);\n\n$event = $client-\u003eevents-\u003eretrieve('eventId');\n\nvar_dump($event);"
},
{
"lang": "Go",
"source": "package main\n\nimport (\n \"context\"\n \"fmt\"\n\n \"github.com/chunkifydev/chunkify-go\"\n \"github.com/chunkifydev/chunkify-go/option\"\n)\n\nfunc main() {\n client := chunkify.NewClient(\n option.WithProjectAccessToken(\"My Project Access Token\"),\n )\n event, err := client.Events.Get(context.TODO(), \"eventId\")\n if err != nil {\n panic(err.Error())\n }\n fmt.Printf(\"%+v\\n\", event)\n}\n"
}
]
}
}
```
```json #/components/schemas/EventResponse
{
"properties": {
"data": {
"$ref": "#/components/schemas/Event"
},
"status": {
"const": "success",
"description": "Status indicates the response status \"success\"",
"type": "string"
}
},
"required": [
"status",
"data"
],
"type": "object"
}
```
```json #/components/schemas/Event
{
"description": "A retained lifecycle event, recorded independently of webhook subscriptions. The payload is an immutable JSON snapshot.",
"properties": {
"created_at": {
"description": "Time the event occurred.",
"format": "date-time",
"type": "string"
},
"deliveries": {
"description": "First 100 delivery attempts, oldest first; included on retrieval. List notifications with event_id to paginate all attempts.",
"items": {
"$ref": "#/components/schemas/Notification"
},
"type": "array"
},
"delivery_count": {
"description": "Number of retained webhook delivery attempts.",
"type": "integer"
},
"delivery_status": {
"description": "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.",
"enum": [
"none",
"pending",
"delivered",
"failed"
],
"type": "string"
},
"event": {
"$ref": "#/components/schemas/WebhookEvent"
},
"expires_at": {
"description": "Retention deadline set from the project team plan when the event was recorded. Deliveries and retries share this deadline.",
"format": "date-time",
"type": "string"
},
"id": {
"description": "Unique event ID.",
"examples": [
"evt_2G6MJiNz71bHQGNzGwKx5cJwPFS"
],
"type": "string"
},
"object_id": {
"description": "ID of the resource that caused this event.",
"type": "string"
},
"payload": {
"description": "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.",
"type": "string"
},
"related_object_ids": {
"description": "Related resource IDs retained independently of resource deletion.",
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"id",
"object_id",
"event",
"created_at",
"expires_at",
"payload",
"related_object_ids",
"delivery_count",
"delivery_status"
],
"type": "object"
}
```
```json #/components/schemas/Notification
{
"properties": {
"created_at": {
"description": "Timestamp when the notification was created",
"examples": [
"2025-01-01T12:00:00Z"
],
"format": "date-time",
"type": "string"
},
"event": {
"$ref": "#/components/schemas/WebhookEvent",
"description": "Type of event that triggered this notification"
},
"event_id": {
"description": "Originating event ID, when recorded by the event log.",
"type": "string"
},
"id": {
"description": "Unique identifier of the notification",
"examples": [
"notf_2G6MJiNz71bHQGNzGwKx5cJwPFS"
],
"type": "string"
},
"object_id": {
"description": "ID of the object that triggered this notification",
"examples": [
"ast_2G6MJiNz71bHQGNzGwKx5cJwPFS"
],
"type": "string"
},
"payload": {
"description": "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}}}"
],
"type": "string"
},
"response_status_code": {
"description": "HTTP status code received from the webhook endpoint",
"examples": [
200
],
"type": "integer"
},
"webhook": {
"allOf": [
{
"$ref": "#/components/schemas/Webhook"
}
],
"description": "Webhook endpoint configuration that received this notification"
}
},
"required": [
"created_at",
"event",
"id",
"object_id",
"payload",
"webhook"
],
"type": "object"
}
```
```json #/components/schemas/WebhookEvent
{
"enum": [
"job.created",
"job.completed",
"job.failed",
"job.cancelled",
"source.created",
"source.deleted",
"upload.created",
"upload.completed",
"upload.failed",
"upload.expired",
"asset.created",
"asset.ready",
"asset.playback_ready",
"asset.failed",
"asset.expired",
"asset.deleted",
"asset.output.created",
"asset.output.ready",
"asset.output.failed",
"asset.output.deleted",
"workflow_run.created",
"workflow_run.completed",
"workflow_run.failed",
"workflow_run.cancelled",
"transcoding.created",
"transcoding.ready",
"transcoding.failed",
"transcoding.cancelled",
"transcoding.expired",
"transcoding.deleted",
"thumbnail.created",
"thumbnail.ready",
"thumbnail.failed",
"thumbnail.expired",
"thumbnail.deleted"
],
"examples": [
"asset.playback_ready"
],
"type": "string"
}
```
```json #/components/schemas/Webhook
{
"properties": {
"enabled": {
"description": "Whether the webhook is currently enabled",
"examples": [
true
],
"type": "boolean"
},
"events": {
"description": "Array of event types this webhook subscribes to",
"examples": [
[
"asset.playback_ready",
"asset.failed"
]
],
"items": {
"$ref": "#/components/schemas/WebhookEvent"
},
"type": "array"
},
"id": {
"description": "Unique identifier of the webhook",
"examples": [
"wh_2G6MJiNz71bHQGNzGwKx5cJwPFS"
],
"type": "string"
},
"project_id": {
"description": "ID of the project this webhook belongs to",
"examples": [
"proj_2G6MJiNz71bHQGNzGwKx5cJwPFS"
],
"type": "string"
},
"url": {
"description": "URL where webhook events will be sent",
"examples": [
"https://example.com/webhook"
],
"type": "string"
}
},
"required": [
"enabled",
"events",
"id",
"project_id",
"url"
],
"type": "object"
}
```
```json #/components/schemas/WebhookEvent
{
"enum": [
"job.created",
"job.completed",
"job.failed",
"job.cancelled",
"source.created",
"source.deleted",
"upload.created",
"upload.completed",
"upload.failed",
"upload.expired",
"asset.created",
"asset.ready",
"asset.playback_ready",
"asset.failed",
"asset.expired",
"asset.deleted",
"asset.output.created",
"asset.output.ready",
"asset.output.failed",
"asset.output.deleted",
"workflow_run.created",
"workflow_run.completed",
"workflow_run.failed",
"workflow_run.cancelled",
"transcoding.created",
"transcoding.ready",
"transcoding.failed",
"transcoding.cancelled",
"transcoding.expired",
"transcoding.deleted",
"thumbnail.created",
"thumbnail.ready",
"thumbnail.failed",
"thumbnail.expired",
"thumbnail.deleted"
],
"examples": [
"asset.playback_ready"
],
"type": "string"
}
```
```json #/components/schemas/WebhookEvent
{
"enum": [
"job.created",
"job.completed",
"job.failed",
"job.cancelled",
"source.created",
"source.deleted",
"upload.created",
"upload.completed",
"upload.failed",
"upload.expired",
"asset.created",
"asset.ready",
"asset.playback_ready",
"asset.failed",
"asset.expired",
"asset.deleted",
"asset.output.created",
"asset.output.ready",
"asset.output.failed",
"asset.output.deleted",
"workflow_run.created",
"workflow_run.completed",
"workflow_run.failed",
"workflow_run.cancelled",
"transcoding.created",
"transcoding.ready",
"transcoding.failed",
"transcoding.cancelled",
"transcoding.expired",
"transcoding.deleted",
"thumbnail.created",
"thumbnail.ready",
"thumbnail.failed",
"thumbnail.expired",
"thumbnail.deleted"
],
"examples": [
"asset.playback_ready"
],
"type": "string"
}
```
```json #/components/schemas/ResponseErrorAuthentication
{
"description": "Error response",
"properties": {
"error": {
"description": "Error response details",
"properties": {
"code": {
"const": 401,
"description": "Code is the HTTP status code",
"examples": [
401
],
"type": "integer"
},
"message": {
"description": "Message is a human-readable error description",
"examples": [
"Authentication error: invalid token or subscription inactive"
],
"type": "string"
},
"type": {
"const": "AuthenticationError",
"description": "Type indicates the error category",
"enum": [
"AuthenticationError"
],
"type": "string"
}
},
"required": [
"type",
"code",
"message"
],
"type": "object"
},
"status": {
"const": "error",
"description": "Status indicates the response status \"error\"",
"type": "string"
}
},
"required": [
"status",
"error"
],
"type": "object"
}
```
```json #/components/schemas/ResponseErrorNotFound
{
"description": "Error response",
"properties": {
"error": {
"description": "Error response details",
"properties": {
"code": {
"const": 404,
"description": "Code is the HTTP status code",
"examples": [
404
],
"type": "integer"
},
"message": {
"description": "Message is a human-readable error description",
"examples": [
"Ressource not found"
],
"type": "string"
},
"type": {
"const": "NotFoundError",
"description": "Type indicates the error category",
"enum": [
"NotFoundError"
],
"type": "string"
}
},
"required": [
"type",
"code",
"message"
],
"type": "object"
},
"status": {
"const": "error",
"description": "Status indicates the response status \"error\"",
"type": "string"
}
},
"required": [
"status",
"error"
],
"type": "object"
}
```
```json #/components/schemas/ResponseErrorTooManyRequests
{
"description": "Error response",
"properties": {
"error": {
"description": "Error response details",
"properties": {
"code": {
"const": 429,
"description": "Code is the HTTP status code",
"examples": [
429
],
"type": "integer"
},
"message": {
"description": "Message is a human-readable error description",
"examples": [
"Rate limit exceeded"
],
"type": "string"
},
"type": {
"const": "TooManyRequestsError",
"description": "Type indicates the error category",
"enum": [
"TooManyRequestsError"
],
"type": "string"
}
},
"required": [
"type",
"code",
"message"
],
"type": "object"
},
"status": {
"const": "error",
"description": "Status indicates the response status \"error\"",
"type": "string"
}
},
"required": [
"status",
"error"
],
"type": "object"
}
```