> For the complete documentation index, see [llms.txt](https://docs.aviator.co/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.aviator.co/mergequeue/concepts/ready-hook.md).

# Ready Hook

Learn what are ready hooks in MergeQueue and how they work. User-defined ready hooks can execute custom JavaScript code to control MergeQueue behavior.

MergeQueue supports user-defined *ready hooks* which can execute custom JavaScript code to finely control how MergeQueue behaves.

The ready hook is executed once whenever a pull request is marked as ready-to-merge (usually via adding the repository's configured label, by using a [slash command](/mergequeue/reference/slash-commands.md), or using the [Aviator API](/api.md)).

The ready hook is defined by creating a file in your GitHub repository at `.aviator/mergequeue/ready.js` and should define a function `ready` that will be called by the [Pilot JavaScript runtime](/pilot-automated-actions/js-execution.md).

{% hint style="info" %}
See how you can use [<mark style="color:blue;">Ready Hook to reduce queue failures due to staleness</mark>](/mergequeue/concepts/reducing-queue-failures-due-to-staleness.md).
{% endhint %}


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.aviator.co/mergequeue/concepts/ready-hook.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.