@heroku-cli/plugin-webhooks

Heroku CLI plugin to manage webhooks

Stats

StarsIssuesVersionUpdatedCreatedSize
@heroku-cli/plugin-webhooks
7272567.54.04 months ago4 years agoMinified + gzip package size for @heroku-cli/plugin-webhooks in KB

Readme

webhooks

oclif Version CircleCI Appveyor CI Downloads/week License

heroku webhooks

list webhooks on an app

USAGE
  $ heroku webhooks

OPTIONS
  -a, --app=app        app to run command against
  -r, --remote=remote  git remote of app to use

EXAMPLE
  $ heroku webhooks

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

heroku webhooks:add

add a webhook to an app

USAGE
  $ heroku webhooks:add

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

EXAMPLE
  $ 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

OPTIONS
  -a, --app=app        app to run command against
  -r, --remote=remote  git remote of app to use
  -s, --status=status  filter deliveries by status

EXAMPLE
  $ 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

OPTIONS
  -a, --app=app        app to run command against
  -r, --remote=remote  git remote of app to use

EXAMPLE
  $ 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

OPTIONS
  -a, --app=app        app to run command against
  -r, --remote=remote  git remote of app to use

EXAMPLE
  $ 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

OPTIONS
  -a, --app=app        app to run command against
  -r, --remote=remote  git remote of app to use

EXAMPLE
  $ 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

OPTIONS
  -a, --app=app        app to run command against
  -r, --remote=remote  git remote of app to use

EXAMPLE
  $ 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

ARGUMENTS
  ID  id of webhook to remove

OPTIONS
  -a, --app=app        app to run command against
  -r, --remote=remote  git remote of app to use

EXAMPLE
  $ 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

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

EXAMPLE
  $ 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

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.