npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@heroku-cli/plugin-events

v0.1.0

Published

Heroku CLI plugin for Heroku Events add-on

Downloads

134

Readme

@heroku-cli/plugin-events

Heroku Events CLI plugin

oclif Version Downloads/week

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

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 AUTH_ID

destroys a Heroku Events authorization

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

ARGUMENTS
  AUTH_ID  Heroku Events authorization id

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 AUTH_ID

shows info for a Heroku Events authorization

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

ARGUMENTS
  AUTH_ID  Heroku Events authorization 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 authorization

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

heroku events:authorizations:sfdc:create ALIAS

creates a Salesforce Platform authorization for Heroku Events

USAGE
  $ heroku events:authorizations:sfdc:create [ALIAS] -a <value> [--browser <value>] [-r <value>]

ARGUMENTS
  ALIAS  user chosen identifier for the org

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

DESCRIPTION
  creates a Salesforce Platform authorization for Heroku Events

See code: dist/commands/events/authorizations/sfdc/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:link SOURCE TARGET

links a publication to a subscription

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

ARGUMENTS
  SOURCE  name or id of an existing subscription
  TARGET  name or id 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:link subAccountChange pubAccountChange -a my-app

See code: dist/commands/events/link.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 Datacloud publication

USAGE
  $ heroku events:publications:datacloud:create [NAME] -a <value> -c <value> --object <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
  -r, --remote=<value>     git remote of app to use
  -s, --source=<value>...  existing subscription name or id to link to
  --object=<value>         (required) object to publish to

DESCRIPTION
  creates a Datacloud publication

EXAMPLES
  # Create a Datacloud 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:sfdc:create NAME

creates a Salesforce Platform publication

USAGE
  $ heroku events:publications:sfdc:create [NAME] -a <value> -e <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
  -e, --event=<value>      (required) event to publish to
  -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

DESCRIPTION
  creates a Salesforce Platform publication

EXAMPLES
  # Create a Salesforce Platform event target that receives …

    $ heroku events:publications:sfdc:create systemStatus -e "/event/System_Status__e" -o my-org

See code: dist/commands/events/publications/sfdc/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: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:sfdc:create NAME

creates a Salesforce Platform subscription

USAGE
  $ heroku events:subscriptions:sfdc:create [NAME] -a <value> -e <value> -A <value> [-f <value> -t <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
  -e, --event=<value>      (required) event to publish to
  -f, --filter=<value>     filter to apply when linking to source
  -r, --remote=<value>     git remote of app to use
  -t, --target=<value>...  existing publication name or id to link to

DESCRIPTION
  creates a Salesforce Platform subscription

EXAMPLES
  # Create a Salesforce Platform subscription for Account Change events from 'my-org'.

    $ heroku events:subscriptions:sfdc:create accountChange -e "/data/AccountChangeEvent" -o my-org

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

heroku events:unlink SOURCE TARGET

unlinks a publication from a subscription

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

ARGUMENTS
  SOURCE  name or id of an existing subscription
  TARGET  name or id 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:unlink subAccountChange pubAccountChange -a my-app

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