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

@commercelayer/cli-plugin-webhooks

v4.0.1

Published

Commerce Layer CLI Webhooks plugin

Downloads

438

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

commercelayer.iocommercelayer.iodrpierludrpierlu

Keywords

ecommerceclicommercelayer

Readme

cli-plugin-webhooks

Commerce Layer CLI Webhooks plugin

oclif Version Downloads/week License

Usage

commercelayer COMMAND

commercelayer [COMMAND] (--help | -h) for detailed information about plugin commands.

Commands

commercelayer webhooks [ID]

List all the registered webhooks or the details of a single webhook.

USAGE
  $ commercelayer webhooks [ID] [-c open|closed] [-t <value>] [-H] [-e]

ARGUMENTS
  ID  unique id of the webhook to get a single webhook

FLAGS
  -H, --hide-empty        hide empty attributes
  -c, --circuit=<option>  show only webhooks with circuit in the declared state
                          <options: open|closed>
  -e, --events            show the last event callbacks associated to the webhook
  -t, --topic=<value>     the event that triggered the webhook

DESCRIPTION
  list all the registered webhooks or the details of a single webhook

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

commercelayer webhooks:create

Create a new webhook.

USAGE
  $ commercelayer webhooks:create -t <value> -u <value> [-i <value>] [-n <value>]

FLAGS
  -i, --include=<value>...  a comma separated list of related resources to be included
  -n, --name=<value>        the webhook short name
  -t, --topic=<value>       (required) the identifier of the event that will trigger the webhook
  -u, --url=<value>         (required) the callback URL used to POST data

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

commercelayer webhooks:destroy ID

Destroy an existing webhook.

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 <webhook-id>>

  $ cl wh:destroy <webhook-id>>

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

commercelayer webhooks:details ID

Show the details of an existing webhook.

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 <webhook-id>

  $ cl webhooks:details <webhook-id> -H

  $ cl wh:details <webhook-id>

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

commercelayer webhooks:event ID

Show the details of a firedf webhook event.

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 <event-id>

  $ cl wh:event <event-id> -p

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

commercelayer webhooks:events ID

List all the events associated to the webhook.

USAGE
  $ commercelayer webhooks:events ID [-A | -l <value>]

ARGUMENTS
  ID  unique id of the webhook

FLAGS
  -A, --all            show all events instead of first 25 only
  -l, --limit=<value>  limit number of events in output

DESCRIPTION
  list all the events associated to the webhook

ALIASES
  $ commercelayer wh:events

EXAMPLES
  $ commercelayer webhooks:events <webhook-id>

  $ cl wh:events <webhook-id>

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

commercelayer webhooks:list

List all the registered webhooks.

USAGE
  $ commercelayer webhooks:list [-c open|closed] [-t <value>]

FLAGS
  -c, --circuit=<option>  show only webhooks with circuit in the declared state
                          <options: open|closed>
  -t, --topic=<value>     the event that triggered the webhook

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

commercelayer webhooks:listen ID

Listen a webhook for outgoing callbacks.

USAGE
  $ commercelayer webhooks:listen ID [-t <value>]

ARGUMENTS
  ID  unique id of the webhook

FLAGS
  -t, --time=<value>  [default: 120] waiting time for the first event

DESCRIPTION
  listen a webhook for outgoing callbacks

ALIASES
  $ commercelayer wh:listen

EXAMPLES
  $ commercelayer webhooks:listen <webhook-id>

  $ cl wh:listen <webhook-id>

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

commercelayer webhooks:payload ID

Show the payload associated to an event callback.

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 <event-id>

  $ cl wh:payload <event-id> -f

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

commercelayer webhooks:reset ID

Reset the circuit breaker associated to the webhook.

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 <webhook-id>

  $ cl wh:reset <webhook-id>

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

commercelayer webhooks:topics

Show online documentation for supported events.

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

commercelayer webhooks:update ID

Update an existing webhook.

USAGE
  $ commercelayer webhooks:update ID [-t <value>] [-u <value>] [-i <value>] [-n <value>]

ARGUMENTS
  ID  unique id of the webhook

FLAGS
  -i, --include=<value>...  a comma separated list of related resources to be included
  -n, --name=<value>        the webhook short name
  -t, --topic=<value>       the identifier of the event that will trigger the webhook
  -u, --url=<value>         the callback URL used to POST data

DESCRIPTION
  update an existing webhook

ALIASES
  $ commercelayer wh:update

EXAMPLES
  $ commercelayer webhooks:update -t customers.create -u https://callback.url.io

  $ cl wh:update -i customer_group

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