@heroku-cli/plugin-events

Heroku Events CLI plugin

• Usage
• Commands

Usage

$ heroku plugins:install @heroku-cli/plugin-events
$ heroku events:COMMAND
running command...
$ heroku events --help [COMMAND]
USAGE
  $ heroku events:COMMAND
...

Commands

• heroku events:authorizations
• heroku events:authorizations:destroy ALIAS
• heroku events:authorizations:info ALIAS
• heroku events:authorizations:salesforce:create ALIAS
• heroku events:generate NAME
• heroku events:publications
• heroku events:publications:datacloud:create NAME
• heroku events:publications:destroy PUB_NAME_OR_ID
• heroku events:publications:info PUB_NAME_OR_ID
• heroku events:publications:salesforce:create NAME
• heroku events:publications:webhook:create NAME
• heroku events:streams
• heroku events:streams:create SOURCE TARGET
• heroku events:streams:destroy SOURCE TARGET
• heroku events:subscriptions
• heroku events:subscriptions:destroy SUB_NAME_OR_ID
• heroku events:subscriptions:info SUB_NAME_OR_ID
• heroku events:subscriptions:salesforce:create NAME

heroku events:authorizations

lists Heroku Events authorizations

USAGE
  $ heroku events:authorizations -a <value> [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  lists Heroku Events authorizations

See code: dist/commands/events/authorizations/index.ts

heroku events:authorizations:destroy ALIAS

destroys a Heroku Events authorization

USAGE
  $ heroku events:authorizations:destroy [ALIAS] -a <value> [-c <value>] [-r <value>]

ARGUMENTS
  ALIAS  Heroku Events authorization alias

FLAGS
  -a, --app=<value>      (required) app to run command against
  -c, --confirm=<value>
  -r, --remote=<value>   git remote of app to use

DESCRIPTION
  destroys a Heroku Events authorization

See code: dist/commands/events/authorizations/destroy.ts

heroku events:authorizations:info ALIAS

shows info for a Heroku Events authorization

USAGE
  $ heroku events:authorizations:info [ALIAS] -a <value> [-r <value>]

ARGUMENTS
  ALIAS  Heroku Events authorization alias

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  shows info for a Heroku Events authorization

See code: dist/commands/events/authorizations/info.ts

heroku events:authorizations:salesforce:create ALIAS

creates a Salesforce Platform authorization for Heroku Events

USAGE
  $ heroku events:authorizations:salesforce:create [ALIAS] -a <value> [--browser <value>] [--sandbox | -l <value>] [-r
  <value>]

ARGUMENTS
  ALIAS  user chosen identifier for the org

FLAGS
  -a, --app=<value>        (required) app to run command against
  -l, --login-url=<value>  login URL to use for Salesforce login
  -r, --remote=<value>     git remote of app to use
  --browser=<value>        browser to open OAuth flow with (example: "firefox", "safari")
  --sandbox                use sandbox login URL

DESCRIPTION
  creates a Salesforce Platform authorization for Heroku Events

See code: dist/commands/events/authorizations/salesforce/create.ts

heroku events:generate NAME

creates an event generator

USAGE
  $ heroku events:generate [NAME] -a <value> -i <value> -m <value> [-r <value>] [-t <value>]

ARGUMENTS
  NAME  name to assign to the event generator

FLAGS
  -a, --app=<value>        (required) app to run command against
  -i, --interval=<value>   (required) how often to trigger the event
  -m, --mapping=<value>    (required) the payload to be generated
  -r, --remote=<value>     git remote of app to use
  -t, --target=<value>...  existing publication id or name to link to

DESCRIPTION
  creates an event generator

EXAMPLES
  # Create an event generator named "my-generator" that triggers every minute

    $ heroku events:generate my-generator -i "1m" -m "root = {this}" -a my-app

See code: dist/commands/events/generate.ts

heroku events:publications

lists Heroku Events publications

USAGE
  $ heroku events:publications -a <value> [-j] [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -j, --json            output in json format
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  lists Heroku Events publications

See code: dist/commands/events/publications/index.ts

heroku events:publications:datacloud:create NAME

creates a Data Cloud publication

USAGE
  $ heroku events:publications:datacloud:create [NAME] -a <value> -c <value> -o <value> -A <value> [-f <value> -s
  <value>] [-r <value>]

ARGUMENTS
  NAME  name to assign to the publication created

FLAGS
  -A, --auth=<value>       (required) authorized Salesforce Org alias
  -a, --app=<value>        (required) app to run command against
  -c, --connector=<value>  (required) ingest API Data Connector name
  -f, --filter=<value>     filter to apply when linking to source
  -o, --object=<value>     (required) object to publish to
  -r, --remote=<value>     git remote of app to use
  -s, --source=<value>...  existing subscription name or id to link to

DESCRIPTION
  creates a Data Cloud publication

EXAMPLES
  # Create a Data Cloud target ingesting …

    $ heroku events:publications:datacloud:create ordersDataTarget -c "SalesConnector" --object "Orders" -o "my-org"

See code: dist/commands/events/publications/datacloud/create.ts

heroku events:publications:destroy PUB_NAME_OR_ID

unlinks and destroys a Heroku Events publication

USAGE
  $ heroku events:publications:destroy [PUB_NAME_OR_ID] -a <value> [-c <value>] [-r <value>]

ARGUMENTS
  PUB_NAME_OR_ID  Heroku Events publication name or id

FLAGS
  -a, --app=<value>      (required) app to run command against
  -c, --confirm=<value>
  -r, --remote=<value>   git remote of app to use

DESCRIPTION
  unlinks and destroys a Heroku Events publication

See code: dist/commands/events/publications/destroy.ts

heroku events:publications:info PUB_NAME_OR_ID

shows info for a Heroku Events publication

USAGE
  $ heroku events:publications:info [PUB_NAME_OR_ID] -a <value> [-r <value>]

ARGUMENTS
  PUB_NAME_OR_ID  Heroku Events publication name or id

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  shows info for a Heroku Events publication

See code: dist/commands/events/publications/info.ts

heroku events:publications:salesforce:create NAME

creates a Heroku Events publication to publish Salesforce Platform Event or Change Data Capture events

USAGE
  $ heroku events:publications:salesforce:create [NAME] -a <value> -t <value> -A <value> [-f <value> -s <value>] [-r
  <value>]

ARGUMENTS
  NAME  name to assign to the publication created

FLAGS
  -A, --auth=<value>             (required) authorized Salesforce Org alias
  -a, --app=<value>              (required) app to run command against
  -f, --filter=<value>           filter to apply when linking to source
  -r, --remote=<value>           git remote of app to use
  -s, --subscribe-to=<value>...  existing subscription name(s) or id(s) to link to
  -t, --topic=<value>            (required) topic to publish to

DESCRIPTION
  creates a Heroku Events publication to publish Salesforce Platform Event or Change Data Capture events

EXAMPLES
  # Create a Heroku Event publication to publish 'System_Status' Platform Event events

    $ heroku events:publications:salesforce:create systemStatus -t "/event/System_Status__e" -A my-org

See code: dist/commands/events/publications/salesforce/create.ts

heroku events:publications:webhook:create NAME

creates a webhook publication

USAGE
  $ heroku events:publications:webhook:create [NAME] -a <value> -u <value> [-f <value> -s <value>] [-r <value>] [-t
  <value>] [-H <value>]

ARGUMENTS
  NAME  name to assign to the publication created

FLAGS
  -H, --header=<value>     [default: Authorization] header field to use for access token
  -a, --app=<value>        (required) app to run command against
  -f, --filter=<value>     filter to apply when linking to source
  -r, --remote=<value>     git remote of app to use
  -s, --source=<value>...  existing subscription name or id to link to
  -t, --token=<value>      access token
  -u, --url=<value>        (required) webhook URL

DESCRIPTION
  creates a webhook publication

EXAMPLES
  # Create a Webhook URL target

    $ heroku events:publications:webhook:create opportunityChanged -u "https://my-app.herokuapp.com/webhooks" -a \
      my-app

See code: dist/commands/events/publications/webhook/create.ts

heroku events:streams

lists Heroku Events streams

USAGE
  $ heroku events:streams -a <value> [-j] [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -j, --json            output in json format
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  lists Heroku Events streams

See code: dist/commands/events/streams/index.ts

heroku events:streams:create SOURCE TARGET

links a publication to a subscription

USAGE
  $ heroku events:streams:create [SOURCE] [TARGET] -a <value> [-f <value> ] [-r <value>]

ARGUMENTS
  SOURCE  name of an existing subscription
  TARGET  name of an existing publication

FLAGS
  -a, --app=<value>     (required) app to run command against
  -f, --filter=<value>  filter to apply
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  links a publication to a subscription

EXAMPLES
  $ heroku events:streams:create subAccountChange pubAccountChange -a my-app

See code: dist/commands/events/streams/create.ts

heroku events:streams:destroy SOURCE TARGET

unlinks a publication from a subscription

USAGE
  $ heroku events:streams:destroy [SOURCE] [TARGET] -a <value> [-r <value>]

ARGUMENTS
  SOURCE  name of an existing subscription
  TARGET  name of an existing publication

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  unlinks a publication from a subscription

EXAMPLES
  $ heroku events:streams:destroy subAccountChange pubAccountChange -a my-app

See code: dist/commands/events/streams/destroy.ts

heroku events:subscriptions

lists Heroku Events subscriptions

USAGE
  $ heroku events:subscriptions -a <value> [-j] [-r <value>]

FLAGS
  -a, --app=<value>     (required) app to run command against
  -j, --json            output in json format
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  lists Heroku Events subscriptions

See code: dist/commands/events/subscriptions/index.ts

heroku events:subscriptions:destroy SUB_NAME_OR_ID

unlinks and destroys a Heroku Events subscription

USAGE
  $ heroku events:subscriptions:destroy [SUB_NAME_OR_ID] -a <value> [-c <value>] [-r <value>]

ARGUMENTS
  SUB_NAME_OR_ID  Heroku Events subscription name or id

FLAGS
  -a, --app=<value>      (required) app to run command against
  -c, --confirm=<value>
  -r, --remote=<value>   git remote of app to use

DESCRIPTION
  unlinks and destroys a Heroku Events subscription

See code: dist/commands/events/subscriptions/destroy.ts

heroku events:subscriptions:info SUB_NAME_OR_ID

shows info for a Heroku Events subscription

USAGE
  $ heroku events:subscriptions:info [SUB_NAME_OR_ID] -a <value> [-r <value>]

ARGUMENTS
  SUB_NAME_OR_ID  Heroku Events subscription name or id

FLAGS
  -a, --app=<value>     (required) app to run command against
  -r, --remote=<value>  git remote of app to use

DESCRIPTION
  shows info for a Heroku Events subscription

See code: dist/commands/events/subscriptions/info.ts

heroku events:subscriptions:salesforce:create NAME

creates a Heroku Events subscription to receive Salesforce Platform Event or Change Data Capture events

USAGE
  $ heroku events:subscriptions:salesforce:create [NAME] -a <value> -t <value> -A <value> [-f <value> -p <value>] [-r
  <value>]

ARGUMENTS
  NAME  name to assign to the subscription created

FLAGS
  -A, --auth=<value>           (required) authorized Salesforce Org alias
  -a, --app=<value>            (required) app to run command against
  -f, --filter=<value>         filter to apply when linking to source
  -p, --publish-to=<value>...  existing publication name(s) or id(s) to link to
  -r, --remote=<value>         git remote of app to use
  -t, --topics=<value>...      (required) 1 or more topic(s) to subscribe to

DESCRIPTION
  creates a Heroku Events subscription to receive Salesforce Platform Event or Change Data Capture events

EXAMPLES
  # Create a Salesforce Platform Event or Change Data Capture subscription for AccountChangeEvent events from
  'my-org'.

    $ heroku events:subscriptions:salesforce:create accountChange -t "/data/AccountChangeEvent" -A my-org

See code: dist/commands/events/subscriptions/salesforce/create.ts