Creates a hook
POST/v3/hooks
Creates a hook for one of your predefined searches.
Delivers search results for the query referenced by the search_id to the target_url via HTTP POST. Note that a hook_id will be returned on successful creation, this id is needed to delete the hook.
We are also returning the header: X-Hook-Secret, a shared secret used to sign the document body pushed to your target_url.
Specify company_id if your search_id is not in your default company.
Request
Responses
- 201
- 400
- 401
- 403
- 404
- 409
- 500
Successfully Created
Missing required parameters.
Invalid or expired token.
Not entitled to the service
The search you are trying to create a REST hook for was not found.
The hook you are trying to create already exists for the specified search_id and target_url.
Something went wrong while trying to create your REST hook.