ManagementExperimental
Delete a webhook endpoint
Removes the endpoint and stops deliveries to it. Its delivery history is no longer reachable through this API.
delete
/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.
Responses
200The removed endpointapplication/jsonShow response bodyHide response body
dataobjectShow propertiesHide properties
webhookEndpointReferencestringIdentifies the endpoint in GET /management/webhooks/{webhookEndpointReference}/deliveries.
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.
descriptionstring | nullFree-text label for the endpoint.
activebooleanWhether events are delivered to this endpoint.
createdAtstring · date-timeupdatedAtstring · date-time401Unauthorized - 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