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

Create a project webhook configuration

Creates a webhook configuration for a project. Supply url for the webhook destination and optionally set enabled to control whether the webhook is active. The response includes the configuration identifier and generated webhook secret.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
projectIdintegerrequired
The integer identifier of the project to add the webhook configuration to.

Webhook configuration settings for a project.

enabledbooleanoptional
Whether the webhook configuration is enabled.
urlstringrequired
The webhook destination URL. Must contain 0 to 255 characters.

5 status codes
200Returns the created webhook configuration, including its identifier, URL, enabled status, webhook secret, automatic-disable status, and execution timestamps when available.
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 the request is invalid, including when `url` is missing or exceeds 255 characters.
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 not authorized.
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 create a webhook configuration for the project.
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 is not found.
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 the request is invalid; a 401 when the authenticated user is not authorized; a 403 when the authenticated user lacks permission; and a 404 when the project is not found. The projectId path parameter must identify an existing project. The body must include url, which can contain 0 to 255 characters.