@heroku-cli/plugin-webhooks-v5
v7.24.0
Published
Heroku CLI plugin to manage webhooks.
Downloads
318
Maintainers
Keywords
Readme
heroku-webhooks
@heroku-cli/plugin-webhooks-v5 webhooks
@heroku-cli/plugin-webhooks-v5 webhooks:add
@heroku-cli/plugin-webhooks-v5 webhooks:deliveries
@heroku-cli/plugin-webhooks-v5 webhooks:deliveries:info [ID]
@heroku-cli/plugin-webhooks-v5 webhooks:events
@heroku-cli/plugin-webhooks-v5 webhooks:events:info [ID]
@heroku-cli/plugin-webhooks-v5 webhooks:info [ID]
@heroku-cli/plugin-webhooks-v5 webhooks:remove [ID]
@heroku-cli/plugin-webhooks-v5 webhooks:update [ID]
@heroku-cli/plugin-webhooks-v5 webhooks
list webhooks on an app
USAGE
$ @heroku-cli/plugin-webhooks-v5 webhooks
OPTIONS
-a, --app=app app to run command against
-r, --remote=remote git remote of app to use
EXAMPLE
$ heroku webhooks
See code: commands/webhooks/index.js
@heroku-cli/plugin-webhooks-v5 webhooks:add
add a webhook to an app
USAGE
$ @heroku-cli/plugin-webhooks-v5 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: commands/webhooks/add.js
@heroku-cli/plugin-webhooks-v5 webhooks:deliveries
list webhook deliveries on an app
USAGE
$ @heroku-cli/plugin-webhooks-v5 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: commands/webhooks/deliveries/index.js
@heroku-cli/plugin-webhooks-v5 webhooks:deliveries:info [ID]
info for a webhook event on an app
USAGE
$ @heroku-cli/plugin-webhooks-v5 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: commands/webhooks/deliveries/info.js
@heroku-cli/plugin-webhooks-v5 webhooks:events
list webhook events on an app
USAGE
$ @heroku-cli/plugin-webhooks-v5 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: commands/webhooks/events/index.js
@heroku-cli/plugin-webhooks-v5 webhooks:events:info [ID]
info for a webhook event on an app
USAGE
$ @heroku-cli/plugin-webhooks-v5 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: commands/webhooks/events/info.js
@heroku-cli/plugin-webhooks-v5 webhooks:info [ID]
info for a webhook on an app
USAGE
$ @heroku-cli/plugin-webhooks-v5 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: commands/webhooks/info.js
@heroku-cli/plugin-webhooks-v5 webhooks:remove [ID]
removes a webhook from an app
USAGE
$ @heroku-cli/plugin-webhooks-v5 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: commands/webhooks/remove.js
@heroku-cli/plugin-webhooks-v5 webhooks:update [ID]
updates a webhook in an app
USAGE
$ @heroku-cli/plugin-webhooks-v5 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: commands/webhooks/update.js