Back to Woocommerce

wc webhook

docs/wc-cli/wc-cli-commands/wc-webhook.md

11.0.0-dev2.5 KB
Original Source

Manage WooCommerce webhook resources.

wc webhook list

List all webhooks.

  • --context - Scope under which the request is made; determines fields present in response.

  • --page - Current page of the collection.

  • --per_page - Maximum number of items to be returned in result set. Defaults to 100 items.

  • --search - Limit results to those matching a string.

  • --after - Limit response to resources published after a given ISO8601 compliant date.

  • --before - Limit response to resources published before a given ISO8601 compliant date.

  • --exclude - Ensure result set excludes specific IDs.

  • --include - Limit result set to specific ids.

  • --offset - Offset the result set by a specific number of items.

  • --order - Order sort attribute ascending or descending.

  • --orderby - Sort collection by object attribute.

  • --status - Limit result set to webhooks assigned a specific status.

  • --fields - Limit response to specific fields. Defaults to all fields.

  • --field - Get the value of an individual field.

  • --format - Render response in a particular format.

    Default: table

    Options: table, json, csv, ids, yaml, count, headers, body, envelope

wc webhook create

Create a new webhook.

  • --name - A friendly name for the webhook.
  • --status - Webhook status.
  • --topic - Webhook topic. (Required)
  • --secret - Webhook secret. (Required)
  • --delivery_url - Webhook delivery URL. (Required)
  • --porcelain - Output just the id when the operation is successful.

wc webhook get <id>

Get a single webhook.

  • --context - Scope under which the request is made; determines fields present in response.

  • --fields - Limit response to specific fields. Defaults to all fields.

  • --field - Get the value of an individual field.

  • --format - Render response in a particular format.

    Default: table

    Options: table, json, csv, yaml, headers, body, envelope

wc webhook update <id>

Update an existing webhook.

  • --name - A friendly name for the webhook.
  • --status - Webhook status.
  • --topic - Webhook topic.
  • --secret - Secret key used to generate a hash of the delivered webhook and provided in the request headers. The default is an MD5 hash from the current user's ID|username if not provided.
  • --porcelain - Output just the id when the operation is successful.

wc webhook delete <id>

Delete an existing webhook.

  • --force - Required to be true, as resource does not support trashing.
  • --porcelain - Output just the id when the operation is successful.