---
title: "getHook"
canonical: "https://support.appfire.com/space/SCLI/73368893/getHook"
format: markdown
---
See also: [Actions](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73368507)

> Macro (details)
> 
> | **Description** | Get hook information by hook name or key for a project or repository scoped hook. |
> | --- | --- |
> | **Required Parameters** | [project](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73368805), [hook](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73367639) |
> | **Optional Parameters** | [repository](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73368867), [outputType](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73368777), [file](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73370741), [append](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73370891), [encoding](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73368755) |
> | **Type** | [Get](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73370540/Action+Types#ActionTypes-Get) |
> | **Category** | [Hooks](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73371318/Action+Categories#ActionCategories-Hooks) |
> | **Output Formats** |  |
> | **Replacement Variables** | project, projectId, projectUrl, repository, repositoryId, repositoryUrl, hook, hookName, hookConfiguration |
> | **Hosting** | server,datacenter |
> | **Since Version** |  |
> | **Examples** | [getHook](https://appfire.atlassian.net/wiki/spaces/SCLI/pages/73371753/Examples#Examples-getHook) |

## Related How To's

> Macro (cql-query)