---
title: "Hook"
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.gitpando.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Pando API

## Fields

- `Hook.id` (string, required)
- `Hook.type` (string, required)
  - one of `"web"`, `"buildkite"`
- `Hook.events` (array<string>, required)
  - one of `"push"`, `"branch.opened"`, `"merged"`, `"tag"`
- `Hook.active` (boolean, required)
- `Hook.created_at` (string, required)
  - format `date-time`
- `Hook.url` (string | null, optional)
- `Hook.buildkite` (object | null, optional)
  - `Hook.buildkite.organization` (string, optional)
  - `Hook.buildkite.pipeline` (string, optional)
- `Hook.app` (string | null, optional) — The app its status tokens stamp: `buildkite` for a buildkite hook, a web hook's own `app`, or null.
- `Hook.created_by` (string, optional)


Source: https://docs.gitpando.com/api/schemas/Hook/index.md