Skip to main content
PATCH
PATCH /webhooks/{id}
Rename, pause or resume a subscription. Required permission: webhooks.manage. Send an Idempotency-Key. Use {"enabled": false} to pause, {"enabled": true} to resume, or {"name": "New name"} to rename. Pause is not a replay buffer; pending deliveries may be cancelled and missed events are not backfilled. URL, events and signing secret cannot be changed: archive and create a new subscription instead.
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. See the Platform webhook 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}$

Path Parameters

id
string
required
Pattern: ^[A-Za-z0-9_-]{1,100}$

Body

application/json

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

name
string
Required string length: 1 - 100
Pattern: ^[^\u0000-\u001f\u007f]+$
enabled
boolean

Response

Safe live-authorized result

data
object
required