---
title: "Trigger manual hook"
method: POST
path: "/api/v1/hooks/{hookID}/invoke"
tags: ["Hook"]
---

# Trigger manual hook

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

Invoke the hook with custom payload. The payload will be added to the standard `invocation` event hook request and sent to the hook. The hook response is returned in the invocation response payload.

<Callout type="warn">
Values for standard json hook response attributes (`request_id`, `action`, ...) will NOT be overwritten.
</Callout>

<Callout type="warn">
Attribute `timeout_s` in hook `config` for this endpoint `POST /v1/hooks/{id}/invoke` will be overwritten by default value of 30.
</Callout>

## Path parameters

- `hookID` integer, required

## Request body

- object — Object with properties to be merged into the invocation payload.

## Response `200`

OK

- object — Hook response merged with invocation response payload.

## Other responses

- `400` — Bad Request - Not having proper event and action in hook object or non-json response.
- `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
- `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)