Skip to content

Latest commit

 

History

History
229 lines (159 loc) · 6.21 KB

webhooks.md

File metadata and controls

229 lines (159 loc) · 6.21 KB
Raw

heroku webhooks

list webhooks on an app

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>  authorization 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>]

ARGUMENTS
  ID  ID of the webhook event

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>]

ARGUMENTS
  ID  ID of the webhook event

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>]

ARGUMENTS
  ID  ID of the webhook

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>]

ARGUMENTS
  ID  ID of the webhook

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>  authorization 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