ManagementExperimental
Update a webhook endpoint
Changes the URL, the subscribed event types, their settings, the label or active. Only the fields sent change; the signing secret stays as issued.
/management/webhooks/{webhookEndpointReference}Authorization
Authorization: Bearer {token} — an OAuth2 access token from the client-credentials flow. How authentication works
Path parameters
webhookEndpointReferencestringrequiredWebhook endpoint reference, as returned by GET /management/webhooks.
Request body
application/json · required
urlstring · urieventTypesarray of stringReplaces the subscription list. Values from GET /catalog/webhook-event-types.
configurationobjectSettings per event type. An event type sent replaces that event type's settings; the others keep theirs.
Show propertiesHide properties
package.usage.thresholdobjectShow propertiesHide properties
thresholdPercentsarray of integerrequiredShares of a package's allowance, in whole percents, at which this endpoint receives package.usage.threshold. At most 5, at least 10 percent apart. An endpoint that never set them receives the event at 33 and 66.
descriptionstringactivebooleanFalse keeps the endpoint but stops deliveries to it.
Responses
200The updated endpointapplication/jsonShow response bodyHide response body
dataobjectShow propertiesHide properties
webhookEndpointReferencestringIdentifies the endpoint in the /management/webhooks/{webhookEndpointReference} operations.
urlstring · uriDestination Firsty posts events to.
eventTypesarray of stringEvent types delivered to this endpoint. Values this client subscribed to before an event type was retired are returned as stored, so an entry may be absent from GET /catalog/webhook-event-types.
configurationobjectThe settings in effect per event type, defaults included. They apply once the endpoint is subscribed to the event type.
Show propertiesHide properties
package.usage.thresholdobjectShow propertiesHide properties
thresholdPercentsarray of integerShares of a package's allowance, in whole percents, at which this endpoint receives package.usage.threshold. At most 5, at least 10 percent apart. An endpoint that never set them receives the event at 33 and 66.
descriptionstring | nullFree-text label for the endpoint.
activebooleanWhether events are delivered to this endpoint.
createdAtstring · date-timeupdatedAtstring · date-time400Bad request - invalid parameters401Unauthorized - missing or invalid API key404Resource not found429Rate limit exceeded. A `429` can also arrive without these headers or this body; handle it by its status code.500Internal server error