# Ready Hook

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: Querying This Documentation

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

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

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

The question should be specific, self-contained, and written in natural language.
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.