Hook Template
List hook templates
Retrieve all hook template objects.
get/api/v1/hook_templates
Query parameters
page_sizeinteger
Number of results per page
cursorstring
A value used for cursor-based pagination. Obtain this value from the next or previous URLs in a paginated response. Do not construct cursor values manually.
ordering'order' | '-order'
Result ordering.
Response
OK
Example response
{
"results": [
{
"id": 1,
"type": "function",
"name": "Document sorting",
"url": "https://example.rossum.app/api/v1/hook_templates/1",
"events": [
"annotation_status.changed"
],
"sideload": [
"queues"
],
"metadata": {
"some_key": "some_value"
},
"config": {
"runtime": "nodejs22.x",
"code": "exports.rossum_hook_request_handler = () => {\nconst messages = [{\"type\": \"info\", \"content\": \"Yup!\"}];\nconst operations = [];\nreturn {\nmessages,\noperations\n};\n};",
"schedule": {
"cron": "*/10 * * * *"
}
},
"description": "Automatically sort documents into specific queues based on document type (i.e. invoice, bill, PO etc.), POs, vendor, total amount, due date, product or locale.",
"extension_source": "rossum_store",
"guide": "Here we explain how the extension should be used.",
"read_more_url": "https://github.com/rossumai/simple-vendor-matching-webhook-python",
"extension_image_url": "https://rossum.ai/wp-content/themes/rossum/static/img/logo.svg",
"store_description": "<p>Automatically sort documents into specific queues based on document type (i.e. invoice, bill, PO etc.), POs, vendor, total amount, due date, product or locale.</p>",
"use_token_owner": true,
"install_action": "copy"
}
]
}Changes
No recorded changes to this endpoint across all 1 revision of this API.