heroku / heroku-webhooks

this code is now in https://github.com/heroku/cli

heroku-webhooks

Commands

• @heroku-cli/plugin-webhooks webhooks
• @heroku-cli/plugin-webhooks webhooks:add
• @heroku-cli/plugin-webhooks webhooks:deliveries
• @heroku-cli/plugin-webhooks webhooks:deliveries:info [ID]
• @heroku-cli/plugin-webhooks webhooks:events
• @heroku-cli/plugin-webhooks webhooks:events:info [ID]
• @heroku-cli/plugin-webhooks webhooks:info [ID]
• @heroku-cli/plugin-webhooks webhooks:remove [ID]
• @heroku-cli/plugin-webhooks webhooks:update [ID]

webhooks

list webhooks on an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks

OPTIONS
  -a, --app=app  app to run command against

EXAMPLE
  $ heroku webhooks

See code: commands/webhooks.js

webhooks:add

add a webhook to an app

USAGE
  $ @heroku-cli/plugin-webhooks 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
  -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: commands/webhooks/add.js

webhooks:deliveries

list webhook deliveries on an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:deliveries

OPTIONS
  -a, --app=app        app to run command against
  -s, --status=status  filter deliveries by status

EXAMPLE
  $ heroku webhooks:deliveries

See code: commands/webhooks/deliveries.js

webhooks:deliveries:info [ID]

info for a webhook event on an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:deliveries:info [ID]

OPTIONS
  -a, --app=app  app to run command against

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

See code: commands/webhooks/deliveries/info.js

webhooks:deliveries:info [ID]

info for a webhook event on an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:deliveries:info [ID]

OPTIONS
  -a, --app=app  app to run command against

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

See code: commands/webhooks/deliveries/info.js

webhooks:events

list webhook events on an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:events

OPTIONS
  -a, --app=app  app to run command against

EXAMPLE
  $ heroku webhooks:events

See code: commands/webhooks/events.js

webhooks:events:info [ID]

info for a webhook event on an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:events:info [ID]

OPTIONS
  -a, --app=app  app to run command against

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

See code: commands/webhooks/events/info.js

webhooks:events:info [ID]

info for a webhook event on an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:events:info [ID]

OPTIONS
  -a, --app=app  app to run command against

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

See code: commands/webhooks/events/info.js

webhooks:info [ID]

info for a webhook on an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:info [ID]

OPTIONS
  -a, --app=app  app to run command against

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

See code: commands/webhooks/info.js

webhooks:remove [ID]

removes a webhook from an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:remove [ID]

ARGUMENTS
  ID  id of webhook to remove

OPTIONS
  -a, --app=app  app to run command against

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

See code: commands/webhooks/remove.js

webhooks:update [ID]

updates a webhook in an app

USAGE
  $ @heroku-cli/plugin-webhooks 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
  -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: commands/webhooks/update.js

webhooks:add

add a webhook to an app

USAGE
  $ @heroku-cli/plugin-webhooks 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
  -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: commands/webhooks/add.js

webhooks:deliveries

list webhook deliveries on an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:deliveries

OPTIONS
  -a, --app=app        app to run command against
  -s, --status=status  filter deliveries by status

EXAMPLE
  $ heroku webhooks:deliveries

See code: commands/webhooks/deliveries.js

webhooks:deliveries:info [ID]

info for a webhook event on an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:deliveries:info [ID]

OPTIONS
  -a, --app=app  app to run command against

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

See code: commands/webhooks/deliveries/info.js

webhooks:deliveries:info [ID]

info for a webhook event on an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:deliveries:info [ID]

OPTIONS
  -a, --app=app  app to run command against

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

See code: commands/webhooks/deliveries/info.js

webhooks:events

list webhook events on an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:events

OPTIONS
  -a, --app=app  app to run command against

EXAMPLE
  $ heroku webhooks:events

See code: commands/webhooks/events.js

webhooks:events:info [ID]

info for a webhook event on an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:events:info [ID]

OPTIONS
  -a, --app=app  app to run command against

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

See code: commands/webhooks/events/info.js

webhooks:events:info [ID]

info for a webhook event on an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:events:info [ID]

OPTIONS
  -a, --app=app  app to run command against

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

See code: commands/webhooks/events/info.js

webhooks:info [ID]

info for a webhook on an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:info [ID]

OPTIONS
  -a, --app=app  app to run command against

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

See code: commands/webhooks/info.js

webhooks:remove [ID]

removes a webhook from an app

USAGE
  $ @heroku-cli/plugin-webhooks webhooks:remove [ID]

ARGUMENTS
  ID  id of webhook to remove

OPTIONS
  -a, --app=app  app to run command against

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

See code: commands/webhooks/remove.js

webhooks:update [ID]

updates a webhook in an app

USAGE
  $ @heroku-cli/plugin-webhooks 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
  -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: commands/webhooks/update.js

heroku-webhooks's Issues

Make `level` optional with default: `notify`?

Reading through the docs, it makes me think that since notify is going to be used in 80% of cases, we should just make it a default, and allow people to override on the CLI if they want sync. Thoughts?

cc @nsamsami for Product's thoughts. My guess is that less required params means it'll be easier for people to use.