You can use a webhook in edoc archive service to introduce your own logic into the processing of archiving processes and to enhance edoc archive service.
To use a webhook, you must first provide the webhook under an endpoint. The endpoint must be accessible for edoc archive service.
For more information about defining a webhook see: What data is sent to my webhook to change values for ECM destination properties before archiving and is expected as a response?
You need the following data from your webhook to establish a connection:
-
Endpoint at which the webhook can be reached.
-
Optional: API key for authentication (security).
Once you have configured and deployed an endpoint for the webhook to change values, you can use this endpoint in edoc archive service.
Here's how
-
Go to the edoc platform system environment and open the administration of edoc archive service in the browser.
-
Navigate to Configure endpoints for webhooks > Create new endpoint for webhook.
-
Enter a meaningful name for the endpoint under Enter the name for the endpoint. The name is displayed in various configuration options for the webhooks.
-
Under Enter description for the endpoint, enter a meaningful description in which you explain the function of the webhook in more detail.
-
Under Select purpose for the endpoint, select the purpose Change values for ECM destination properties before the archiving process starts. By specifying this, you determine when the webhook is used, what information is sent to the webhook and what information is expected from the webhook.
-
Under Specify URL of the endpoint, enter the URL of the endpoint in the format of a URL (e.g. https://myURL.com) to which the queries for the webhook are to be sent.
-
Under Enter the secret API key, enter the secret API key for authentication at the endpoint. If there is no authentication mechanism for the endpoint, do not enter anything.
-
Under Specify timeout for connection setup, enter the maximum number of seconds that a connection setup may take before a timeout occurs.
-
Click on Save.
You have successfully configured the endpoint.
Tip
Test the specified connection data with Test connection.