---
title: "Test hook"
method: POST
path: "/api/v1/hooks/{hookID}/test"
tags: ["Hook"]
---

# Test hook

`POST /api/v1/hooks/{hookID}/test`

Test a hook with custom payload. Test endpoint will return result generated by the specified Hook which would be normally processed by Rossum.

## Path parameters

- `hookID` integer, required

## Request body

- object
  - `config` object — You can override default [configuration](/api/hook) of hook being executed. The `runtime` attribute is required for function hook if custom config is set.
  - `payload` object, required — Payload sent to the Hook, please note only [supported](/guides/extensions#webhook-extension) combination of `action` and `event` can be passed.

## Response `200`

OK

- object
  - `response` object — Response from the hook.

## Other responses

- `400` — Invalid input data.
- `401` — The username/password is invalid or token is invalid (e.g. expired).
- `403` — Insufficient permission, missing authentication, invalid CSRF token and similar issue.
- `404` — The specified resource was not found.
- `409` — Conflict - Test function is not ready yet, request should be retried after 10 seconds.
- `413` — Payload too large (especially for files uploaded).
- `429` — Request rate is too high, wait before sending more requests. See [Rate Limiting](/guides/overview#rate-limiting) for more details.
- `500` — Server failure while processing the request.
- `502` — Invalid response from the upstream server.
- `503` — We're temporarily offline for maintenance. Please try again later.
- `504` — Upstream server could not complete the request in time.

---

[API](https://skmtc.dev/rossum/apis/rossum-api.md) · [All operations](https://skmtc.dev/rossum/apis/rossum-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/rossum/rossum-api/revisions/f1b5a910991d/schema)