Skip to contentDevelopersPrezly website
Webhooks

Update Newsroom Webhook

Change selected webhook settings, event subscriptions, or activation.

Personal tokens are not supported for this endpoint. Use an integration API key. Your account must also have access to the requested data. Authentication

Omitted properties are preserved; events replaces the full event list. Disable before changing the destination or rotating the shared secret.

Read the guide

PATCH
/newsrooms/{newsroom_id}/webhooks/{id}

Callbacks POST JSON with action and event resource data. When configured, secret is included as a JSON body property; there is no HMAC signature header. Delivery is queued; no retry schedule, ordering or exactly-once delivery guarantee is provided by this contract. Supplied events replaces the full event list. Webhook management requires an account integration credential; personal tokens and newsroom integration credentials are not supported.

Personal access tokens are not supported for this endpoint. Use an integration API key with the required permissions.

Story creation and update notifications are suppressed when the resulting story is confidential. A public → confidential transition can therefore produce no story.updated notification. story.deleted notifications are still sent. Consumers publishing cached copies must reconcile current publication status and visibility; webhooks alone cannot reliably withdraw confidential content.

Authorization

API_key
headerAuthorizationBearer <token>

Bearer authentication using an integration API key, or a personal access token only where the operation explicitly supports it. Every listed personal-token scope is required; owner permissions and newsroom access still apply.

Path Parameters

newsroom_id*string

Newsroom UUID or ID

Length1 <= length
id*string

Webhook ID

Request Body

application/json
  1. body
name?string
Length1 <= length <= 255
url?string
Formaturi
events?array<>
secret?|

Set null to clear the body secret; omit to retain it.

Length1 <= length <= 300
is_active?boolean
request_options?

HTTP client options used for callback delivery. Default timeout is 10 seconds; the object replaces stored options.

Response Body

OK

application/json
  1. response
webhook?
Example Request
curl -X PATCH 'https://api.prezly.com/v2/newsrooms/string/webhooks/string' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response200
{  "webhook": {    "id": "string",    "name": "string",    "url": "string",    "events": [      "story.created"    ],    "secret": "string",    "is_active": true,    "request_options": {}  }}