webhooks

Register a minted webhook URL at an HTTPS destination without exposing the credential.

Register a minted webhook URL at an HTTPS destination without exposing the credential. Pass the handle from webhookUrlMint, webhookUrlRotate, or webhookList. Destination type http performs an outbound HTTPS request and substitutes {{webhookUrl}} (and optional {{webhookSecret}} — package-owned HMAC from the webhook URL record, or a verification.secretName copied onto that record at mint or rotate) server-side into url/headers/body — interactive MCP only, and only after the owner Approves the exact destination via the same account approval flow as /connect/secrets host approval (approval_url → website Allow → durable grant → retry). Package-owned HMAC is not a user secrets-list entry and never needs a secret→host Allow; destination.secretName Bearer auth does. For GitHub repository hooks, POST https://api.github.com/repos/{owner}/{repo}/hooks with User-Agent kody, {{webhookUrl}} in config.url, {{webhookSecret}} in config.secret when HMAC is declared (omit verification.secretName so mint stores package-owned HMAC), and integration "github" (or a host-approved token). Returns ok, remote_id, and url_host only — never the credential URL or signing secret.

Org permission: package:write.

post/v1/webhooks/apply

Request

  • Base URL: https://api.kody.codes
  • URL: https://api.kody.codes/v1/webhooks/apply
  • Auth: HTTP bearer

Request body

handlestring required

Opaque handle from webhookUrlMint, webhookUrlRotate, or webhookList.

Response

Success.

okboolean required
url_hoststring required
http_statusinteger required
remote_idstring nullable required
errorstring nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.