Documentation menu
Project Environment Webhooks

Update an environment webhook subscription

PATCH /api/v1/projects/{projectId}/environments/{environmentId}/webhooks/{webhookId}

Setting enabled to true returns the subscription to live delivery. In an installation restricted to private Webhook destinations, enabling or editing a live subscription requires an installation-configured private HTTPS destination and enabled event delivery; otherwise the update returns 409 with details.conflictReason outbound_webhooks_unsupported and changes nothing. Pausing and editing a paused subscription stay available.

Parameters

path

NameTypeRequiredDescription
projectIdstringrequiredIdentifies the Project that owns the addressed resource. Applies to Update an environment webhook subscription.
environmentIdstringrequiredIdentifies the Project environment addressed by the operation. Applies to Update an environment webhook subscription.
webhookIdstringrequiredIdentifies the Project webhook being addressed. Applies to Update an environment webhook subscription.

Request body

Required — Request body for: Update an environment webhook subscription.

application/json

NameTypeRequiredDescription
endpointUrlstringoptional
eventTypesarray<"operation.approval.status_changed" | "operation.invocation.status_changed" | "deployment.queued" | "deployment.validating" | "deployment.provisioning" | "deployment.materializing" | "deployment.ready" | "deployment.failed" | "deployment.canceled" | "activation.changed" | "run.created" | "run.started" | "run.completed" | "run.failed" | "run.canceled" | "run.expired" | "system_agent.published" | "system_agent.policy_changed" | "domain.entity.created" | "domain.entity.updated" | "domain.entity.transitioned" | "domain.entity.deleted">optional
enabledbooleanoptional

Responses

StatusDescriptionBody
200Response for status 200application/json — object — data: object (required)
400The request is malformed or cannot be processed.application/json — PublicApiError — error: object (required)
401Authentication failed. The Authorization header is missing, or the credential is invalid or expired.application/json — PublicApiError — error: object (required)
403Access denied. The authenticated user does not have permission to perform this action.application/json — PublicApiError — error: object (required)
404Resource not found.application/json — PublicApiError — error: object (required)
409Request conflicts with current state of the resource, including safe deployment conflict classifications.application/json — PublicApiError — error: object (required)
422Request validation failed. Check the request body, query parameters, or path parameters.application/json — PublicApiError — error: object (required)
429Too many requests.application/json — PublicApiError — error: object (required)
500The server could not complete the request.application/json — PublicApiError — error: object (required)
503Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff.application/json — PublicApiError — error: object (required)