Create a notification

Send an event notification to a webhook endpoint. Recorded events replay their original payload.

POST

/notifications

Authorization

header

string

required

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

Bodyapplication/json

Notification creation parameters

event

string

required

Event specifies the type of event that triggered the 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

object_id

string

required

ID of the resource that triggered the event. Use the caption, static rendition, or thumbnail ID for their Asset child events. Replaying asset events, job.created, or source.created requires a retained snapshot. Resource deletion does not prevent replay.

Examples:

ast_A1cce6120E56e7Tu9ioP09Nhjk9

webhook_id

string

required

WebhookId specifies the webhook endpoint that will receive the notification.

Examples:

wh_A1cce6120E56e7Tu9ioP09Nhjk9

Responses

application/json

data

object

required

Data contains the response object

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

status

"success"

string

required

Status indicates the response status "success"

The notification was created successfully

application/json

error

object

required

status

"error"

string

required

Status indicates the response status "error"

Invalid request parameters

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', }); const notification = await client.notifications.create({ event: 'asset.playback_ready', object_id: 'ast_A1cce6120E56e7Tu9ioP09Nhjk9', webhook_id: 'wh_A1cce6120E56e7Tu9ioP09Nhjk9', }); console.log(notification);

from chunkify import Chunkify client = Chunkify( project_access_token="My Project Access Token", ) notification = client.notifications.create( event="asset.playback_ready", object_id="ast_A1cce6120E56e7Tu9ioP09Nhjk9", webhook_id="wh_A1cce6120E56e7Tu9ioP09Nhjk9", ) print(notification)

<?php use Chunkify\Client; $client = new Client( projectAccessToken: 'My Project Access Token', ); $notification = $client->notifications->create( event: 'asset.playback_ready', objectID: 'ast_A1cce6120E56e7Tu9ioP09Nhjk9', webhookID: 'wh_A1cce6120E56e7Tu9ioP09Nhjk9', ); var_dump($notification);

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"), ) notification, err := client.Notifications.New(context.TODO(), chunkify.NotificationNewParams{ Event: chunkify.NotificationNewParamsEventAssetPlaybackReady, ObjectID: "ast_A1cce6120E56e7Tu9ioP09Nhjk9", WebhookID: "wh_A1cce6120E56e7Tu9ioP09Nhjk9", }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", notification) }

{ "data": { "created_at": "2025-01-01T12:00:00Z", "event": "asset.playback_ready", "id": "notf_2G6MJiNz71bHQGNzGwKx5cJwPFS", "object_id": "ast_2G6MJiNz71bHQGNzGwKx5cJwPFS", "payload": "{\"id\":\"notf_2G6MJiNz71bHQGNzGwKx5cJwPFS\",\"event\":\"asset.playback_ready\",\"date\":\"2025-01-01T12:00:00Z\",\"data\":{\"asset\":{\"id\":\"ast_2G6MJiNz71bHQGNzGwKx5cJwPFS\",\"status\":\"preparing\",\"playback_ready\":true}}}", "webhook": { "enabled": true, "events": [ "asset.playback_ready", "asset.failed" ], "id": "wh_2G6MJiNz71bHQGNzGwKx5cJwPFS", "project_id": "proj_2G6MJiNz71bHQGNzGwKx5cJwPFS", "url": "https://example.com/webhook" } }, "status": "success" }