Tolgee Octri Demo
PUT/v2/projects/{projectId}/webhook-configs/{id}

Update a webhook configuration

Updates a webhook configuration for a project. Supply the configuration url and optionally set enabled to control whether the webhook runs; the URL must be no longer than 255 characters. The response includes the updated configuration.

2 parameters · 2 body fields
idintegerrequired
The numeric identifier of the webhook configuration to update.
projectIdintegerrequired
The numeric identifier of the project that owns the webhook configuration.

Webhook configuration values to update. Supply url; enabled can be included to set whether the webhook is active.

enabledbooleanoptional
Whether the webhook is enabled. Disabled webhooks are not executed.
urlstringrequired
The webhook destination URL. Must be no longer than 255 characters.

5 status codes
200Returns the updated webhook configuration, including its identifier, URL, enabled and auto-disabled states, webhook secret, and failure and execution timestamps.
autoDisabledbooleanrequired
Whether the webhook was automatically disabled due to persistent failures.
enabledbooleanrequired
Whether the webhook is enabled. Disabled webhooks are not executed.
firstFailedintegeroptional
Date of the first failed webhook request. If the last webhook request is successful, this value is set to null.
idintegerrequired
lastExecutedintegeroptional
Date of the last webhook request.
urlstringrequired
webhookSecretstringrequired
400Returned when `url` is missing or exceeds 255 characters, or a request value is invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when the request is unauthenticated.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user does not have permission to update the webhook configuration.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the project or webhook configuration does not exist.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

A 400 is returned when url is missing or exceeds 255 characters, or when another request value is invalid. A 401 indicates the request is unauthenticated, and a 403 indicates the authenticated user lacks permission to update the configuration. A 404 indicates that the projectId or id does not identify an existing project webhook configuration.