Skip to main content
Version: 3.x

webhook

Manage the environment's webhooks​

webhook​

$ saleor webhook --help

Help output:

saleor webhook [command]

Manage the environment's webhooks

Commands:
  saleor webhook list     List webhooks for an environment
  saleor webhook create   Create a new webhook
  saleor webhook edit     Edit a webhook
  saleor webhook update   Update webhooks for an environment
  saleor webhook dry-run  Webhook dry run

Options:
      --json             Output the data as JSON  [boolean] [default: false]
      --short            Output data as text  [boolean] [default: false]
  -u, --instance, --url  Saleor instance API URL (must start with the protocol, i.e. https:// or http://)  [string]
  -V, --version          Show version number  [boolean]
  -h, --help             Show help  [boolean]

webhook list​

$ saleor webhook list --help

Help output:

saleor webhook list

List webhooks for an environment

Options:
      --json             Output the data as JSON  [boolean] [default: false]
      --short            Output data as text  [boolean] [default: false]
  -u, --instance, --url  Saleor instance API URL (must start with the protocol, i.e. https:// or http://)  [string]
  -V, --version          Show version number  [boolean]
  -h, --help             Show help  [boolean]

webhook create​

$ saleor webhook create --help

Help output:

saleor webhook create

Create a new webhook

Options:
      --json             Output the data as JSON  [boolean] [default: false]
      --short            Output data as text  [boolean] [default: false]
  -u, --instance, --url  Saleor instance API URL (must start with the protocol, i.e. https:// or http://)  [string]
  -V, --version          Show version number  [boolean]
  -h, --help             Show help  [boolean]

webhook edit​

$ saleor webhook edit --help

Help output:

saleor webhook edit

Edit a webhook

Options:
      --json             Output the data as JSON  [boolean] [default: false]
      --short            Output data as text  [boolean] [default: false]
  -u, --instance, --url  Saleor instance API URL (must start with the protocol, i.e. https:// or http://)  [string]
  -V, --version          Show version number  [boolean]
  -h, --help             Show help  [boolean]

webhook update​

$ saleor webhook update --help

Help output:

saleor webhook update

Update webhooks for an environment

Options:
      --json             Output the data as JSON  [boolean] [default: false]
      --short            Output data as text  [boolean] [default: false]
  -u, --instance, --url  Saleor instance API URL (must start with the protocol, i.e. https:// or http://)  [string]
  -V, --version          Show version number  [boolean]
  -h, --help             Show help  [boolean]

webhook dry-run​

$ saleor webhook dry-run --help

Help output:

saleor webhook dry-run

Webhook dry run

Options:
      --json             Output the data as JSON  [boolean] [default: false]
      --short            Output data as text  [boolean] [default: false]
  -u, --instance, --url  Saleor instance API URL (must start with the protocol, i.e. https:// or http://)  [string]
      --object-id        Object ID to perform dry run on  [string]
      --query            Subscription query  [string]
  -V, --version          Show version number  [boolean]
  -h, --help             Show help  [boolean]

Examples:
  saleor webhook dry-run
  saleor webhook dry-run --query='subscription { event { ... on ProductCreated { product { id name } } } }'
  saleor webhook dry-run --object-id='UHJvZHVjdDo3Mg=='
Was this page helpful?