The following pages will help you troubleshoot the most common issues that may come up when trying to implement a REST Webhook.
When troubleshooting REST webhooks, start by identifying the HTTP status code returned by the request. The returned status code often indicates the source of the problem, such as authentication, configuration, permissions, or trigger matching issues.
HTTP 401 Unauthorized Eror
The following are the possible reasons and solutions for the HTTP 401 error:
| Reason | Solution |
|---|---|
| The service user token has expired. | Generate a new service user token and send the webhook request again. |
| The service user does not have permission to access the application. | Verify that the service user has the required application permissions. For more information, see Creating a Service User in the Content Innovation Cloud Administration Portal documentation. |
HTTP 404 Not Found Error
An HTTP 404 error typically indicates that the webhook endpoint could not be found or that the incoming request does not match the configured trigger.
To make sure that this is the cause of the error, verify the request with the trigger event conditions that are listed below. If any one of the conditions are not met, the trigger will not be matched, and the trigger action will not fire.
The following are the possible reasons and solutions for the HTTP 404 (not found) error:
| Reason | Solution |
|---|---|
| Trigger event path for the webhook is incorrect. |
Trigger Event Path (URL) should be:https://<BPM_GUID>.studio.app.hyland.com/<deployed-application-name>-<env-id-prefix>/connector/<rest-connector>/events/<webhook-path> The values of variables can be found as follows:
This path has to be pasted into . |
| The trigger event is configured incorrectly. | Verify the method configured in . For more information, see Creating Triggers, and REST Connector Triggers to see a list of available methods. |
| The trigger event condition is not met. | Verify the trigger condition configured for the webhook in and make sure that they are met in the process. For more information, see Creating Triggers. |
| The trigger event header is configured incorrectly. | Verify the trigger event header configured for the webhook in . This is a list of static request header values that must match with the configuration in order for the trigger to be fired. |
| Trigger parameter values are configured incorrectly. | Verify the trigger parameters configured for the webhook in . This is a list of static URL parameter values that must match with the configuration in order for the trigger to be fired. |
| The service user does not have permission to access the application. | See Creating a Service User in the Content Innovation Cloud Administration Portal documentation. |
HTTP 422 Unprocessable Content Error
This issue comes up when you try to call a webhook with a service user token that does not have the correct scopes. Create a service user token with the following 3 scopes: hxp, hxp.integrations, and hxps.
Trigger Is Not Executed and No Error Is Returned
In some situations, a webhook request completes successfully without returning an error, but the expected trigger action does not execute.
This typically indicates an issue with the trigger action configuration rather than the webhook request itself.
| Reason | Solution |
|---|---|
| The trigger action payload is malformed. |
Open up the trigger in the JSON Editor (see Choosing a Process Editor). This displays the trigger data in a JSON format. Verify that the JSON looks correct and none of the properties are incorrect. |
| The trigger action variable mapping is trying to map invalid data properties. | f you try to map the entire eventobject to a start process action, the process may not start due to data type issues. It is always a good practice to only map the necessary event request properties to each trigger action. |