cli-plugin-webhooks

cli-plugin-webhooks

Commerce Layer CLI Webhooks plugin

Usage

$ cl-webhooks COMMAND

$ cl-webhooks (-v | version | --version) to check the version of the CLI you have installed.

$ cl-webhooks [COMMAND] (--help | -h) for detailed information about CLI commands.

Commands

• cl-webhooks webhooks
• cl-webhooks webhooks:create
• cl-webhooks webhooks:destroy ID
• cl-webhooks webhooks:details ID
• cl-webhooks webhooks:list
• cl-webhooks webhooks:reset ID
• cl-webhooks webhooks:update ID

cl-webhooks webhooks

List all the registered webhooks.

USAGE
  $ cl-webhooks webhooks

OPTIONS
  -c, --circuit=open|closed        show only webhooks with circuit in the decalred state
  -o, --organization=organization  (required) the slug of your organization

See code: src/commands/webhooks/index.ts

cl-webhooks webhooks:create

Create a new webhook.

USAGE
  $ cl-webhooks webhooks:create

OPTIONS
  -i, --include=include            a comma separated list of related resources to be included
  -o, --organization=organization  (required) the slug of your organization
  -t, --topic=topic                (required) the identifier of the event that will trigger the webhook
  -u, --url=url                    (required) the callback URL used to POST data

See code: src/commands/webhooks/create.ts

cl-webhooks webhooks:destroy ID

Destroy an existing webhook.

USAGE
  $ cl-webhooks webhooks:destroy ID

ARGUMENTS
  ID  unique id of the webhook

OPTIONS
  -o, --organization=organization  (required) the slug of your organization

ALIASES
  $ cl-webhooks webhooks:delete
  $ cl-webhooks wh:delete
  $ cl-webhooks wh:destroy

See code: src/commands/webhooks/destroy.ts

cl-webhooks webhooks:details ID

Show the details of an existing webhook.

USAGE
  $ cl-webhooks webhooks:details ID

ARGUMENTS
  ID  unique id of the webhook

OPTIONS
  -H, --hide-empty                 hide empty attributes
  -o, --organization=organization  (required) the slug of your organization

ALIASES
  $ cl-webhooks webhook
  $ cl-webhooks wh:details

See code: src/commands/webhooks/details.ts

cl-webhooks webhooks:list

List all the registered webhooks.

USAGE
  $ cl-webhooks webhooks:list

OPTIONS
  -c, --circuit=open|closed        show only webhooks with circuit in the decalred state
  -o, --organization=organization  (required) the slug of your organization

ALIASES
  $ cl-webhooks wh:list

EXAMPLES
  $ commercelayer webhooks
  $ cl webhooks:list
  $ cl wh:list

See code: src/commands/webhooks/list.ts

cl-webhooks webhooks:reset ID

Reset the circuit breaker associated to the webhook.

USAGE
  $ cl-webhooks webhooks:reset ID

ARGUMENTS
  ID  unique id of the webhook

OPTIONS
  -o, --organization=organization  (required) the slug of your organization

See code: src/commands/webhooks/reset.ts

cl-webhooks webhooks:update ID

Create a new webhook.

USAGE
  $ cl-webhooks webhooks:update ID

ARGUMENTS
  ID  unique id of the webhook

OPTIONS
  -i, --include=include            a comma separated list of related resources to be included
  -o, --organization=organization  (required) the slug of your organization
  -t, --topic=topic                the identifier of the event that will trigger the webhook
  -u, --url=url                    the callback URL used to POST data

See code: src/commands/webhooks/update.ts