webhooks

Mint (or remint) the URL secret for a package-declared webhook and return an opaque handle plus url_host.

Mint (or remint) the URL secret for a package-declared webhook and return an opaque handle plus url_host. Pass createInstance+instanceLabel to mint another URL under the same declared name (each URL needs its own Approve). The credential URL is never returned — register it with webhookUrlApply. Minting does not turn the webhook on: deliveries fail with enablement_not_on until a person opens approval_url and clicks Approve, which runs it as them (and is where its credentials are mapped). Existing approvals are kept across remint and rotate.

Org permission: package:write.

post/v1/webhooks/{webhookName}/url

Request

  • Base URL: https://api.kody.codes
  • URL: https://api.kody.codes/v1/webhooks/{webhookName}/url
  • Auth: HTTP bearer

Path parameters

webhookNamestring required

Webhook name from package.json#kody.webhooks[].name.

Request body

packageIdstring

Saved-package UUID. Use when the scoped name is not known, or for a stable ref.

kodyIdstring

Package name (@owner/leaf or the name leaf). Prefer this when you know the name.

createInstanceboolean

When true, mint another URL under the same declared name. Requires instanceLabel.

instanceLabelstring

Short label to tell this URL apart from others under the same name.

Response

Success.

Changes

No recorded changes to this operation across all 1 revision of this API.