@heroku-cli/plugin-event-relay

heroku-event-relay-cli

• Installation
• Commands

Installation

Run the following command:

$ heroku plugins:install event-relay

Commands

• heroku event-relay [CLUSTER]
• heroku event-relay:sinks [CLUSTER]
• heroku event-relay:sinks:create TOPIC GROUP TARGET_URL [CLUSTER]
• heroku event-relay:sinks:destroy [SINK_ID] [CLUSTER]
• heroku event-relay:sinks:info SINK_ID [CLUSTER]

heroku event-relay [CLUSTER]

get information on the status of your event relay

USAGE
  $ heroku event-relay [CLUSTER]

OPTIONS
  -a, --app=app  (required) app to run command against

EXAMPLE
  $ heroku event-relay

See code: src/commands/event-relay.ts

heroku event-relay:sinks [CLUSTER]

list all your event relay sinks

USAGE
  $ heroku event-relay:sinks [CLUSTER]

OPTIONS
  -a, --app=app  (required) app to run command against

ALIASES
  $ heroku event-relay:sinks:list

EXAMPLE
  $ heroku event-relay:sinks

See code: src/commands/event-relay/sinks.ts

heroku event-relay:sinks:create TOPIC GROUP TARGET_URL [CLUSTER]

create your event relay sink

USAGE
  $ heroku event-relay:sinks:create TOPIC GROUP TARGET_URL [CLUSTER]

OPTIONS
  -a, --app=app  (required) app to run command against

EXAMPLE
  $ heroku event-relay:sinks:create messages messages-group https://her-demo.herokuapp.com/receive

See code: src/commands/event-relay/sinks/create.ts

heroku event-relay:sinks:destroy [SINK_ID] [CLUSTER]

destroy your event relay sink

USAGE
  $ heroku event-relay:sinks:destroy [SINK_ID] [CLUSTER]

OPTIONS
  -a, --app=app  (required) app to run command against
  --all          destroy all sinks

ALIASES
  $ heroku event-relay:sinks:delete

EXAMPLES
  $ heroku event-relay:sinks:destroy be0576df-d6e7-4974-96ee-ec87ce0425b7

  $ heroku event-relay:sinks:destroy --all

See code: src/commands/event-relay/sinks/destroy.ts

heroku event-relay:sinks:info SINK_ID [CLUSTER]

get information on your event relay sink

USAGE
  $ heroku event-relay:sinks:info SINK_ID [CLUSTER]

OPTIONS
  -a, --app=app  (required) app to run command against

EXAMPLE
  $ heroku event-relay:sinks 71ae6b05-9881-450d-bd94-ded2a6c8afcc

See code: src/commands/event-relay/sinks/info.ts