Skip to content
Pando

Register a hook (owners)

web: a signed JSON POST to url (see webhooks below). buildkite: Pando calls Buildkite's create-build API, POST https://api.buildkite.com/v2/organizations/{organization}/pipelines/{pipeline}/builds, with the Worker secret BUILDKITE_API_TOKEN, for push events (by default) on branches that are not deleted. The build gets commit, branch, message, and env: PANDO_CLONE_URL, PANDO_READ_TOKEN (read only, this repo, at least 24 hours: Buildkite's Retry reruns a job with this env), PANDO_STATUS_URL, PANDO_STATUS_TOKEN (posts checks on this commit for 24 hours, stamped buildkite; see createStatus; pando status <state> uses it), PANDO_MONOREPO, PANDO_REPO, PANDO_BRANCH, PANDO_HEAD, PANDO_DELIVERY, PANDO_SEQ. Its meta_data has pando_delivery, pando_monorepo (the id) and pando_repo, which Pando's Buildkite webhook uses to map the build back (the ci tag).

POST
https://app.gitpando.com/v1/monorepos/{owner}/{monorepo}/repos/{repo}/hooks
View as Markdown

Authorisation

  • credentialoptionalHTTP
  • sessionoptionalAPI key in cookie

Path parameters

  • ownerstringrequired

    The monorepo's owner, a namespace (a person's login or an organization). Matched without case.

    pattern: ^[a-z0-9](?:[a-z0-9]|-(?=[a-z0-9])){0,38}$
  • monorepostringrequired

    The monorepo's name within its owner (or an old name). Matched without case.

    pattern: ^[a-z0-9](?:[a-z0-9._]|-(?!-)){0,38}$
  • repostringrequired

    The repo's name (projects-web).

Request bodyJSONrequired

  • typeweborbuildkiterequired
  • urloptionalstring

    Required for web.

  • secretoptionalstring

    For web, the HMAC key. Write only.

  • eventsoptionalarray ofpushorbranch.openedormergedortag

    Default [push, branch.opened, merged, tag] for web, [push, merged] for buildkite (a merge builds main's merge commit).

  • buildkiteoptionalobject
    2 properties
    • organizationstringrequired
    • pipelinestringrequired
  • appoptionalstring

    For web: the CI service behind it (github-actions, circleci, ...), stamped as app on statuses posted with its deliveries' status tokens. Not buildkite (that is the buildkite type's).

    pattern: ^[a-z0-9][a-z0-9-]{0,38}$

Returns

201

Created

JSON
  • idstringrequired
  • typeweborbuildkiterequired
  • eventsarray ofpushorbranch.openedormergedortagrequired
  • activebooleanrequired
  • created_atstringrequired
    format: date-time
  • urloptionalstring | null
  • buildkiteoptionalobject | null
    2 properties
    • organizationoptionalstring
    • pipelineoptionalstring
  • appoptionalstring | null

    The app its status tokens stamp: buildkite for a buildkite hook, a web hook's own app, or null.

  • created_byoptionalstring
Navigation

Type to search…

↑↓ navigate↵ selectEsc close