Update webhook subscription

PATCH 
/webhooks/:id

Updates a webhook subscription's destination URL, event names, description, or enabled state. The HMAC secret is never returned by this endpoint.

Request

Path Parameters

id uuidrequired

Resource UUID.

Body

required

destinationUrluri
Example: https://hooks.example.com/align
eventNamesstring[]
Possible values: [entry.created, entry.updated, entry.status_changed, entry.assigned, entry.commented, release.created, release.status_changed, release.released, cost.estimate_requested, cost.estimation.run.started, cost.estimation.run.finished, cost.estimation.run.failed, invoice.paid, invoice.payment_failed, invoice.finalized, cost.approved, cost.rejected, agreement.signed, pr.merged, pr.reopened, github.identity.connected, github.identity.disconnected, github.identity.policy.violated, commit.linked, commit.unlinked, ci.run.attributed, commit.entry.suggestion.generated, commit.risk.generated, release.notes.generated, project.status.update.generated, pr.description.generated, commit.suggestion.surfaced, commit.suggestion.accepted, commit.suggestion.rejected, ci.flaky.override.set, ci.gate.evaluated, agreement.persissio.callback.received, tenant.created, tenant.verified, tenant.suspended, subscription.created, subscription.updated, usage.limit.hit, subscription.upgraded, subscription.downgraded, subscription.cancelled, trial.ending_soon, trial.ended, dunning.email.sent, analytics.tenant.opted_out, analytics.tenant.opted_in, status.incident.created, status.incident.updated, status.incident.resolved, status.component.overridden, changelog.entry.scheduled, changelog.entry.published, api_key.created, api_key.revoked, api_key.used, api.rate_limit.hit, webhook.subscription.created, webhook.subscription.deleted, time.logged, time.submitted, time.approved, time.rejected, time.unlocked, time.updated, time.deleted, report.viewed, report.exported, assistant.conversation_started, assistant.message_sent, assistant.tool_proposed, assistant.tool_confirmed, assistant.tool_executed, assistant.tool_failed, assistant.guardrail_blocked, assistant.action_denied, assistant.external_action_proposed, assistant.external_action_dry_run, assistant.external_action_confirmed, assistant.external_action_executed, assistant.external_action_failed, assistant.external_action_unknown, reviewer.suggestion.generated, commit.linter.advisory.posted, wiki_page.created, wiki_page.updated, wiki_page.deleted, user.invited, user.linked, user.updated, user.bulk_invited, project_member.added, project_member.updated, project_member.removed, integration_link.created, integration_link.updated, assistant.upload_presign_requested, assistant.upload_registered, assistant.upload_scan_started, assistant.upload_scan_passed, assistant.upload_scan_failed, assistant.upload_blocked, assistant.upload_extraction_started, assistant.upload_extracted, assistant.upload_extraction_failed, assistant.upload_redacted, assistant.upload_used_as_context, assistant.upload_deleted, assistant.entry_from_uploads_proposed, assistant.entry_from_uploads_created, assistant.upload_attachment_proposed, assistant.upload_attached_to_entry, assistant.upload_attachment_failed, assistant.comment_with_uploads_proposed, assistant.comment_with_uploads_created, assistant.attachment_lifecycle_viewed, assistant.attachment_remove_proposed, assistant.attachment_removed, assistant.attachment_replace_proposed, assistant.attachment_replaced, assistant.attachment_access_refreshed, assistant.attachment_lifecycle_failed, webhook.test], >= 1
Example: ["entry.created","entry.updated"]
descriptionstring | nullnullable
Example: Notify CI pipeline.
enabledboolean
Example: true

OK

Schema

iduuidrequired
Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6
destinationUrlurirequired
Example: https://hooks.example.com/align
eventNamesstring[]required
Example: ["entry.created","entry.updated"]
enabledbooleanrequired
Example: true
descriptionstring | nullnullablerequired
Example: Notify CI pipeline on entry changes.
createdAtdate-timerequired
Example: 2025-01-01T00:00:00Z