Update an existing webhook subscription

patch

https://datahub-subscription.api.eu1.dev.scalar.zf.com/v1/webhooks/{id}

Partially updates a webhook subscription. At least one field must be provided. If webhookEndpoint is changed, a webhook test is performed. Duplicate names within the same organization result in a 409 Conflict.

Path Params

uuid

required

The unique identifier (GUID) of the subscription

Body Params

Partial update request. At least one field must be provided.

name

string

length between 3 and 250

New name for the webhook subscription

webhookEndpoint

uri

^https://

New HTTPS endpoint URL. Must be a valid HTTPS URL if provided.

batchSize

int32 | null

1 to 500

Updated batch size

maximumWaitingTime

int32 | null

0 to 300000

Updated maximum waiting time in milliseconds

subscriptionEventGroups

array of objects

length ≥ 1

Updated event groups

subscriptionEventGroups

eventGroupName

string

required

Name of the event group to subscribe to

eventGroupVersion

int32

required

Version of the event group

eventNames

array of strings

required

length ≥ 1

Specific event names within the group to subscribe to

eventNames*

isOverflowEnabled

boolean | null

Updated overflow mode setting

customHeaders

array of objects

length ≤ 5

Updated custom headers (replaces existing headers)

customHeaders

Responses

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Webhook subscription successfully updated

400Bad Request - Invalid input or validation failure

401Unauthorized - Missing or invalid JWT token

403Forbidden - Insufficient permissions for the requested operation

404Not Found - The requested subscription does not exist or does not belong to your organization

409Conflict - A webhook with this name already exists

422Unprocessable Entity - Webhook endpoint test failed

500Internal Server Error - An unexpected error occurred