webhooks ======== [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) [![Version](https://img.shields.io/npm/v/webhooks.svg)](https://npmjs.org/package/webhooks) [![CircleCI](https://circleci.com/gh/chadian/webhooks/tree/master.svg?style=shield)](https://circleci.com/gh/chadian/webhooks/tree/master) [![Appveyor CI](https://ci.appveyor.com/api/projects/status/github/chadian/webhooks?branch=master&svg=true)](https://ci.appveyor.com/project/chadian/webhooks/branch/master) [![Codecov](https://codecov.io/gh/chadian/webhooks/branch/master/graph/badge.svg)](https://codecov.io/gh/chadian/webhooks) [![Downloads/week](https://img.shields.io/npm/dw/webhooks.svg)](https://npmjs.org/package/webhooks) [![License](https://img.shields.io/npm/l/webhooks.svg)](https://github.com/chadian/webhooks/blob/master/package.json) * [Usage](#usage) * [Commands](#commands) # Usage ```sh-session $ npm install -g @heroku-cli/plugin-webhooks $ heroku COMMAND running command... $ heroku (-v|--version|version) @heroku-cli/plugin-webhooks/7.47.13 darwin-x64 node-v12.18.4 $ heroku --help [COMMAND] USAGE $ heroku COMMAND ... ``` # Commands * [`heroku webhooks`](#heroku-webhooks) * [`heroku webhooks:add`](#heroku-webhooksadd) * [`heroku webhooks:deliveries`](#heroku-webhooksdeliveries) * [`heroku webhooks:deliveries:info ID`](#heroku-webhooksdeliveriesinfo-id) * [`heroku webhooks:events`](#heroku-webhooksevents) * [`heroku webhooks:events:info ID`](#heroku-webhookseventsinfo-id) * [`heroku webhooks:info ID`](#heroku-webhooksinfo-id) * [`heroku webhooks:remove ID`](#heroku-webhooksremove-id) * [`heroku webhooks:update ID`](#heroku-webhooksupdate-id) ## `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](https://github.com/heroku/cli/blob/v7.47.13/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](https://github.com/heroku/cli/blob/v7.47.13/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](https://github.com/heroku/cli/blob/v7.47.13/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](https://github.com/heroku/cli/blob/v7.47.13/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](https://github.com/heroku/cli/blob/v7.47.13/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](https://github.com/heroku/cli/blob/v7.47.13/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](https://github.com/heroku/cli/blob/v7.47.13/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](https://github.com/heroku/cli/blob/v7.47.13/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](https://github.com/heroku/cli/blob/v7.47.13/src/commands/webhooks/update.ts)_