---
title: "HookPayload"
---

> 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

- `HookPayload.event` (string, required) — `branch.opened`: the first push of a branch. `push`: any push through the door that moves or deletes a branch. `merged`: a Pando merge landed a branch; a buildkite hook builds main's merge commit (`merge_commit`) on main (`main_branch`). `tag`: a tag pushed, moved or deleted (or made by publishing a release): `tag` is its name, `head` its commit (zeros when deleted).
  - one of `"push"`, `"branch.opened"`, `"merged"`, `"tag"`
- `HookPayload.delivery_id` (string, required)
- `HookPayload.occurred_at` (string, required)
  - format `date-time`
- `HookPayload.monorepo` (string, required) — `owner/name` when the delivery was made.
- `HookPayload.monorepo_id` (string, required) — The monorepo's permanent id: a stable key across renames.
- `HookPayload.repo` (string, required)
- `HookPayload.ref` (string, required) — `refs/heads/<branch>`
- `HookPayload.clone_url` (string, required) — The git door URL. Clone it with `read_token`.
- `HookPayload.branch` (string, optional)
- `HookPayload.head` (string, optional) — The new head; all zeros when the branch was deleted.
- `HookPayload.before` (string, optional) — The old head; all zeros for a new branch.
- `HookPayload.base` (string | null, optional) — The merge base with the default branch.
- `HookPayload.title` (string | null, optional)
- `HookPayload.description` (string | null, optional)
- `HookPayload.author` (string | null, optional) — The branch's author (a user).
- `HookPayload.pusher` (string | null, optional) — The user who pushed; for `merged`, who merged. Null only when Pando found a push in Artifacts' refs whose pusher it never learned (its record and its keep both failed).
- `HookPayload.seq` (integer | null, optional) — The event stream's seq for this change: drop repeats, sort by it.
- `HookPayload.merge_commit` (string, optional) — Only for `merged`.
- `HookPayload.diff_url` (string, optional)
- `HookPayload.read_token` (string, optional) — A read-only token for this one repo, valid 30 minutes, minted for this delivery. Use it as `Authorization: Bearer <read_token>` against `clone_url`.
- `HookPayload.read_token_expires_at` (string, optional)
  - format `date-time`
- `HookPayload.status_url` (string, optional) — `POST` a commit status here for `head`, with `status_token` or a member's credential.
- `HookPayload.status_token` (string, optional) — Posts statuses for `head` in this repo for 24 hours, stamped with the hook's `app` (see createStatus). Absent when the Worker secret PANDO_STATUS_SECRET is not set or the branch was deleted.
- `HookPayload.status_token_expires_at` (string, optional)
  - format `date-time`


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