Skip to main content
POST
POST /webhooks
Subscribe your public HTTPS receiver to selected workspace events. Required permission: webhooks.manage. Send an Idempotency-Key. Generate and securely save a separate signingSecret before creating the subscription; it is not an API key and is never returned. Save data.id to view delivery history or pause the subscription. At most ten non-archived subscriptions are allowed, including paused subscriptions.
If this request returns 503, stop the workflow and retry later when instructed, or contact support with the response requestId. Use your Platform key privately in Postman or your backend, not this page. Follow the creation and signature-verification guide.

Authorizations

Authorization
string
header
required

Platform API key for one workspace. Create it in Settings with an expiry date or Never expire. Keep it private; use it from Postman or your backend, not browser code. Widget keys are not accepted.

Headers

Idempotency-Key
string
required

An operation ID, not your API key. Generate a UUID for each new change and reuse it when retrying the same request. See https://docs.layarva.com/developers/platform-request-keys for Postman, PowerShell and Node.js examples. Upload instructions are refreshed when requested again.

Pattern: ^[A-Za-z0-9._:-]{1,128}$

Body

application/json

Send application/json using the fields below. JSON requests must be no larger than 64 KiB.

Create a public HTTPS receiver subscription. Generate an independent random signingSecret (32–256 base64url characters), not your API key. It is accepted only at creation and never returned. URL/events/secret cannot be changed: archive and recreate to rotate. Private destinations, redirects, credentials and query strings are refused.

name
string
required
Required string length: 1 - 100
Pattern: ^[^\u0000-\u001f\u007f]+$
url
string
required
Maximum string length: 2048
events
enum<string>[]
required
Required array length: 1 - 7 elements
Available options:
platform.command.completed,
library.upload.committed,
library.upload.failed,
playlist.ready,
publication.succeeded,
publication.failed,
offline.export.ready
signingSecret
string
required
Required string length: 32 - 256
Pattern: ^[A-Za-z0-9_-]+$

Response

Safe live-authorized result

data
object
required