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

Get one webhook configuration

Retrieves a webhook configuration for a project. Use the projectId and configuration id path values to identify the configuration whose URL, enabled state, and execution history you need to inspect.

2 parameters
idintegerrequired
The numeric identifier of the webhook configuration to retrieve.
projectIdintegerrequired
The numeric identifier of the project that owns the webhook configuration.

5 status codes
200Returns the 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 the request 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 access 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 indicates an invalid request, a 401 indicates the request is unauthenticated, and a 403 indicates the authenticated user lacks permission to access the configuration. A 404 indicates that the projectId or id does not identify an existing project webhook configuration.