This package has been deprecated

Author message:

Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

@heroku-cli/plugin-webhooks

8.1.7 • Public • Published

webhooks

oclif Version CircleCI Appveyor CI Downloads/week License

Usage

$ npm install -g @heroku-cli/plugin-webhooks
$ heroku COMMAND
running command...
$ heroku (--version|-v)
@heroku-cli/plugin-webhooks/8.1.7 darwin-x64 node-v16.19.0
$ heroku --help [COMMAND]
USAGE
  $ heroku COMMAND
...

Commands

heroku webhooks

list webhooks on an app

USAGE
  $ heroku webhooks [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  list webhooks on an app

EXAMPLES
  $ heroku webhooks

See code: src/commands/webhooks/index.ts

heroku webhooks:add

add a webhook to an app

USAGE
  $ heroku webhooks:add -i <value> -l <value> -u <value> [-a <value>] [-r <value>] [-s <value>] [-t <value>]

FLAGS
  -a, --app=<value>            app to run command against
  -i, --include=<value>        (required) comma delimited event types your server will receive
  -l, --level=<value>          (required) notify does not retry, sync will retry until successful or timeout
  -r, --remote=<value>         git remote of app to use
  -s, --secret=<value>         value to sign delivery with in Heroku-Webhook-Hmac-SHA256 header
  -t, --authorization=<value>  authoriation header to send with webhooks
  -u, --url=<value>            (required) URL for receiver

DESCRIPTION
  add a webhook to an app

EXAMPLES
  $ heroku webhooks:add -i api:dyno -l notify -u https://example.com/hooks

See code: src/commands/webhooks/add.ts

heroku webhooks:deliveries

list webhook deliveries on an app

USAGE
  $ heroku webhooks:deliveries [-a <value>] [-r <value>] [-s <value>]

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use
  -s, --status=<value>  filter deliveries by status

DESCRIPTION
  list webhook deliveries on an app

EXAMPLES
  $ heroku webhooks:deliveries

See code: src/commands/webhooks/deliveries/index.ts

heroku webhooks:deliveries:info ID

info for a webhook event on an app

USAGE
  $ heroku webhooks:deliveries:info ID [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  info for a webhook event on an app

EXAMPLES
  $ heroku webhooks:deliveries:info 99999999-9999-9999-9999-999999999999

See code: src/commands/webhooks/deliveries/info.ts

heroku webhooks:events

list webhook events on an app

USAGE
  $ heroku webhooks:events [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  list webhook events on an app

EXAMPLES
  $ heroku webhooks:events

See code: src/commands/webhooks/events/index.ts

heroku webhooks:events:info ID

info for a webhook event on an app

USAGE
  $ heroku webhooks:events:info ID [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  info for a webhook event on an app

EXAMPLES
  $ heroku webhooks:events:info 99999999-9999-9999-9999-999999999999

See code: src/commands/webhooks/events/info.ts

heroku webhooks:info ID

info for a webhook on an app

USAGE
  $ heroku webhooks:info ID [-a <value>] [-r <value>]

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  info for a webhook on an app

EXAMPLES
  $ heroku webhooks:info 99999999-9999-9999-9999-999999999999

See code: src/commands/webhooks/info.ts

heroku webhooks:remove ID

removes a webhook from an app

USAGE
  $ heroku webhooks:remove ID [-a <value>] [-r <value>]

ARGUMENTS
  ID  id of webhook to remove

FLAGS
  -a, --app=<value>     app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  removes a webhook from an app

EXAMPLES
  $ heroku webhooks:remove 99999999-9999-9999-9999-999999999999

See code: src/commands/webhooks/remove.ts

heroku webhooks:update ID

updates a webhook in an app

USAGE
  $ heroku webhooks:update ID -i <value> -l <value> -u <value> [-a <value>] [-r <value>] [-s <value>] [-t <value>]

FLAGS
  -a, --app=<value>            app to run command against
  -i, --include=<value>        (required) comma delimited event types your server will receive
  -l, --level=<value>          (required) notify does not retry, sync will retry until successful or timeout
  -r, --remote=<value>         git remote of app to use
  -s, --secret=<value>         value to sign delivery with in Heroku-Webhook-Hmac-SHA256 header
  -t, --authorization=<value>  authoriation header to send with webhooks
  -u, --url=<value>            (required) URL for receiver

DESCRIPTION
  updates a webhook in an app

EXAMPLES
  $ heroku webhooks:update 99999999-9999-9999-9999-999999999999 -i dyno -l notify -s 09928c40bf1b191b645174a19f7053d16a180da37332e719ef0998f4c0a2 -u https://example.com/hooks

See code: src/commands/webhooks/update.ts

Readme

Keywords

Package Sidebar

Install

npm i @heroku-cli/plugin-webhooks

Weekly Downloads

4,696

Version

8.1.7

License

MIT

Unpacked Size

45.2 kB

Total Files

26

Last publish

Collaborators

  • hillzbot2000
  • kdreyeroren
  • beanieboi
  • beckychen
  • xx-sfdc-npm
  • kpremkumar
  • abhinavkoul
  • daniel.bright
  • justinwilaby-sf
  • cv88
  • jlopezdan
  • jmonreal
  • jondaniel-sfdc
  • dhagberg-sf
  • jmorrell-sfdc
  • elzoona
  • cmarcojos
  • gkommineni
  • vlazuka
  • nlanatta
  • lucaszhou
  • mars
  • mimen
  • wchrisjohnson
  • cbaxtersf
  • heroku-front-end
  • bsperlingsf
  • zli-sf
  • 7ftz
  • joanneyeung
  • montes_heroku
  • jwadsworthsf
  • jheikes
  • lmckenzie
  • sarassassin
  • pfuente
  • reidmix
  • mbuschheroku
  • k.plenty
  • eblack
  • sheax0r
  • k80bowman
  • rdagg-hero
  • grundy.g
  • robinson.m
  • tcareysmith-sfdc
  • ptemporini
  • paulaprado18
  • harish.457
  • ntonollier