The Hook API is a RESTful service that accepts JSON requests. The Hook API endpoints are used to execute the Callback function during the execution of a Process Hook.
Coding with C#?
Read Using Hook APIs to see how the C# Client library makes calling the Extension API simple.
Deprecation
Occasionally, Directscale deprecates a Hook endpoint upon releasing a new Hook. Though we continue to support deprecated Hook endpoints for our customers with existing implementations, we recommend that all new implementations use the latest Hook endpoints.
Callback Token
Hook API endpoints cannot be called directly as they require the X-DirectScale-Callback header with a valid one-time-use token. A one-time-use token is passed in the X-DirectScale-Callback header to the endpoint Configured for a Process Hook when a Directscale System process invokes a Process Hook.
Testing your Hook Implementation?
Hooks can be triggered with the Try it out button that is accessible by clicking 'Models' when editing a hook configuration.
Figure 1: An image of the Hook modal where the 'try it out' button is located.
Examples
Refer to the "C# w/o DS Middleware" tab of these recipes to see an example of how to call the Hook API