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

Test a webhook configuration

Triggers a test request to a webhook configuration in a project. Use the projectId and configuration id path values to select the webhook to test. The response reports whether the test request succeeded.

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

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

5 status codes
200Returns a `success` boolean indicating whether the test request succeeded.
successbooleanrequired
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 test 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 test the configuration. A 404 indicates that the projectId or id does not identify an existing project webhook configuration.