Skip to main content
WEBHOOK

Authorizations

X-Auth-Token
string
header
required

API key created in the dashboard or via POST /v1/api/api-keys. Keys are prefixed pn_ and do not expire until revoked.

Headers

X-PN-Event
enum<string>
required

Event name

Available options:
video.ready,
video.deleted,
caption.added,
caption.updated,
caption.removed,
chapters.updated,
tag.created,
tag.deleted,
video.tags.attached,
video.tags.detached
X-PN-Delivery-Id
string<uuid>
required

Unique per delivery. Use it to de-duplicate retries.

X-PN-Signature
string
required

Timestamped HMAC-SHA256 signature

Example:

"t=1756900000,v1=5f1d...9ab2"

User-Agent
string
Example:

"PNPlayer-Webhooks/1.0"

Body

application/json
id
string
required

Event ID, prefixed evt_

Example:

"evt_9d2c1a3e-1c0f-4b6a-9f1e-2a7c8d5b4e11"

event
string
required

One of the WebhookEvent values, or webhook.test for test deliveries

Example:

"video.ready"

accountId
string
required
createdAt
string<date-time>
required
data
video.ready · object
required

Event-specific payload

Response

200

Return any 2xx status to acknowledge the event