Commerce Layer CLI Webhooks plugin
npm install @commercelayer/cli-plugin-webhooksCommerce Layer CLI Webhooks plugin




``sh-session
commercelayer COMMAND
commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.
`Commands
* [commercelayer webhooks [ID]](#commercelayer-webhooks-id)commercelayer webhooks:create
* commercelayer webhooks:destroy ID
* commercelayer webhooks:details ID
* commercelayer webhooks:disable ID
* commercelayer webhooks:enable ID
* commercelayer webhooks:event ID
* commercelayer webhooks:events ID
* commercelayer webhooks:list
* commercelayer webhooks:listen ID
* commercelayer webhooks:payload ID
* commercelayer webhooks:reset ID
* commercelayer webhooks:topics
* commercelayer webhooks:update ID
*
List all the registered webhooks or the details of a single webhook.
`sh-session
USAGE
$ commercelayer webhooks [ID] [-c open|closed] [-t
ARGUMENTS
ID unique id of the webhook to get a single webhook
FLAGS
-H, --hide-empty hide empty attributes
-c, --circuit=
DESCRIPTION
list all the registered webhooks or the details of a single webhook
`
_See code: src/commands/webhooks/index.ts_
Create a new webhook.
`sh-session
USAGE
$ commercelayer webhooks:create -t
FLAGS
-i, --include=
-n, --name=
-t, --topic=
-u, --url=
DESCRIPTION
create a new webhook
ALIASES
$ commercelayer wh:create
EXAMPLES
$ commercelayer webhooks:create -t customers.create -u https://callback.url.io
$ cl wh:create -t orders.place -u http://myurl.com
`
_See code: src/commands/webhooks/create.ts_
Destroy an existing webhook.
`sh-session
USAGE
$ commercelayer webhooks:destroy ID
ARGUMENTS
ID unique id of the webhook
DESCRIPTION
destroy an existing webhook
ALIASES
$ commercelayer webhooks:delete
$ commercelayer wh:delete
$ commercelayer wh:destroy
EXAMPLES
$ commercelayer webhooks:destroy
$ cl wh:destroy
`
_See code: src/commands/webhooks/destroy.ts_
Show the details of an existing webhook.
`sh-session
USAGE
$ commercelayer webhooks:details ID [-H] [-e]
ARGUMENTS
ID unique id of the webhook
FLAGS
-H, --hide-empty hide empty attributes
-e, --events show the last event callbacks associated to the webhook
DESCRIPTION
show the details of an existing webhook
ALIASES
$ commercelayer wh:details
EXAMPLES
$ commercelayer webhooks:details
$ cl webhooks:details
$ cl wh:details
`
_See code: src/commands/webhooks/details.ts_
Disable an enabled webhook.
`sh-session
USAGE
$ commercelayer webhooks:disable ID
ARGUMENTS
ID unique id of the webhook
DESCRIPTION
disable an enabled webhook
ALIASES
$ commercelayer wh:disable
EXAMPLES
$ commercelayer webhooks:disable
$ cl wh:disable
`
_See code: src/commands/webhooks/disable.ts_
Enable a disabled webhook.
`sh-session
USAGE
$ commercelayer webhooks:enable ID
ARGUMENTS
ID unique id of the webhook
DESCRIPTION
enable a disabled webhook
ALIASES
$ commercelayer wh:enable
EXAMPLES
$ commercelayer webhooks:enable
$ cl wh:enable
`
_See code: src/commands/webhooks/enable.ts_
Show the details of a firedf webhook event.
`sh-session
USAGE
$ commercelayer webhooks:event ID [-f -p]
ARGUMENTS
ID unique id of the webhook
FLAGS
-f, --format format the payload output
-p, --payload show the event payload sent to the callback endpoint
DESCRIPTION
show the details of a firedf webhook event
ALIASES
$ commercelayer wh:event
EXAMPLES
$ commercelayer webhooks:event
$ cl wh:event
`
_See code: src/commands/webhooks/event.ts_
List all the events associated to the webhook.
`sh-session
USAGE
$ commercelayer webhooks:events ID [-A | -l
ARGUMENTS
ID unique id of the webhook
FLAGS
-A, --all show all events instead of first 25 only
-l, --limit=
DESCRIPTION
list all the events associated to the webhook
ALIASES
$ commercelayer wh:events
EXAMPLES
$ commercelayer webhooks:events
$ cl wh:events
`
_See code: src/commands/webhooks/events.ts_
List all the registered webhooks.
`sh-session
USAGE
$ commercelayer webhooks:list [-c open|closed] [-t
FLAGS
-c, --circuit=
DESCRIPTION
list all the registered webhooks
ALIASES
$ commercelayer wh:list
EXAMPLES
$ commercelayer webhooks
$ cl webhooks:list -c open
$ cl wh:list
`
_See code: src/commands/webhooks/list.ts_
Listen a webhook for outgoing callbacks.
`sh-session
USAGE
$ commercelayer webhooks:listen ID [-t
ARGUMENTS
ID unique id of the webhook
FLAGS
-t, --time=
DESCRIPTION
listen a webhook for outgoing callbacks
ALIASES
$ commercelayer wh:listen
EXAMPLES
$ commercelayer webhooks:listen
$ cl wh:listen
`
_See code: src/commands/webhooks/listen.ts_
Show the payload associated to an event callback.
`sh-session
USAGE
$ commercelayer webhooks:payload ID [-f]
ARGUMENTS
ID unique id of the webhook
FLAGS
-f, --format format the payload output
DESCRIPTION
show the payload associated to an event callback
ALIASES
$ commercelayer wh:payload
EXAMPLES
$ commercelayer webhooks:payload
$ cl wh:payload
`
_See code: src/commands/webhooks/payload.ts_
Reset the circuit breaker associated to the webhook.
`sh-session
USAGE
$ commercelayer webhooks:reset ID
ARGUMENTS
ID unique id of the webhook
DESCRIPTION
reset the circuit breaker associated to the webhook
ALIASES
$ commercelayer wh:reset
EXAMPLES
$ commercelayer webhooks:reset
$ cl wh:reset
`
_See code: src/commands/webhooks/reset.ts_
Show online documentation for supported events.
`sh-session
USAGE
$ commercelayer webhooks:topics
DESCRIPTION
show online documentation for supported events
ALIASES
$ commercelayer wh:topics
EXAMPLES
$ commercelayer webhooks:topics
$ cl wh:topics
`
_See code: src/commands/webhooks/topics.ts_
Update an existing webhook.
`sh-session
USAGE
$ commercelayer webhooks:update ID [-t
ARGUMENTS
ID unique id of the webhook
FLAGS
-i, --include=
-n, --name=
-t, --topic=
-u, --url=
DESCRIPTION
update an existing webhook
ALIASES
$ commercelayer wh:update
EXAMPLES
$ commercelayer webhooks:update
$ cl wh:update
``
_See code: src/commands/webhooks/update.ts_