Skip to content

Commit

Permalink
Update manifests
Browse files Browse the repository at this point in the history
  • Loading branch information
@isaacroldan
isaacroldan committed Mar 18, 2024
1 parent 0d1931d commit 2902072
Show file tree
Hide file tree
Showing 3 changed files with 198 additions and 69 deletions.
105 changes: 104 additions & 1 deletion packages/app/oclif.manifest.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1997,6 +1997,109 @@
"strict": true,
"summary": "List deployed versions of your app."
},
"app:webhook:trigger": {
"aliases": [
],
"args": {
},
"description": "\n Triggers the delivery of a sample Admin API event topic payload to a designated address.\n\n You should use this command to experiment with webhooks, to initially test your webhook configuration, or for unit testing. However, to test your webhook configuration from end to end, you should always trigger webhooks by performing the related action in Shopify.\n\n Because most webhook deliveries use remote endpoints, you can trigger the command from any directory where you can use Shopify CLI, and send the webhook to any of the supported endpoint types. For example, you can run the command from your app's local directory, but send the webhook to a staging environment endpoint.\n\n To learn more about using webhooks in a Shopify app, refer to \"Webhooks overview\" (https://shopify.dev/docs/apps/webhooks).\n\n ### Limitations\n\n - Webhooks triggered using this method always have the same payload, so they can't be used to test scenarios that differ based on the payload contents.\n - Webhooks triggered using this method aren't retried when they fail.\n - Trigger requests are rate-limited using the \"Partner API rate limit\" (https://shopify.dev/docs/api/partner#rate_limits).\n - You can't use this method to validate your API webhook subscriptions.\n ",
"descriptionWithMarkdown": "\n Triggers the delivery of a sample Admin API event topic payload to a designated address.\n\n You should use this command to experiment with webhooks, to initially test your webhook configuration, or for unit testing. However, to test your webhook configuration from end to end, you should always trigger webhooks by performing the related action in Shopify.\n\n Because most webhook deliveries use remote endpoints, you can trigger the command from any directory where you can use Shopify CLI, and send the webhook to any of the supported endpoint types. For example, you can run the command from your app's local directory, but send the webhook to a staging environment endpoint.\n\n To learn more about using webhooks in a Shopify app, refer to [Webhooks overview](https://shopify.dev/docs/apps/webhooks).\n\n ### Limitations\n\n - Webhooks triggered using this method always have the same payload, so they can't be used to test scenarios that differ based on the payload contents.\n - Webhooks triggered using this method aren't retried when they fail.\n - Trigger requests are rate-limited using the [Partner API rate limit](https://shopify.dev/docs/api/partner#rate_limits).\n - You can't use this method to validate your API webhook subscriptions.\n ",
"flags": {
"address": {
"description": "The URL where the webhook payload should be sent.\n You will need a different address type for each delivery-method:\n · For remote HTTP testing, use a URL that starts with https://\n · For local HTTP testing, use http://localhost:{port}/{url-path}\n · For Google Pub/Sub, use pubsub://{project-id}:{topic-id}\n · For Amazon EventBridge, use an Amazon Resource Name (ARN) starting with arn:aws:events:",
"env": "SHOPIFY_FLAG_ADDRESS",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "address",
"required": false,
"type": "option"
},
"api-version": {
"description": "The API Version of the webhook topic.",
"env": "SHOPIFY_FLAG_API_VERSION",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "api-version",
"required": false,
"type": "option"
},
"client-secret": {
"description": "Your app's client secret. This secret allows us to return the X-Shopify-Hmac-SHA256 header that lets you validate the origin of the response that you receive.",
"env": "SHOPIFY_FLAG_CLIENT_SECRET",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "client-secret",
"required": false,
"type": "option"
},
"delivery-method": {
"description": "Method chosen to deliver the topic payload. If not passed, it's inferred from the address.",
"env": "SHOPIFY_FLAG_DELIVERY_METHOD",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "delivery-method",
"options": [
"http",
"google-pub-sub",
"event-bridge"
],
"required": false,
"type": "option"
},
"help": {
"allowNo": false,
"description": "This help. When you run the trigger command the CLI will prompt you for any information that isn't passed using flags.",
"env": "SHOPIFY_FLAG_HELP",
"hidden": false,
"name": "help",
"required": false,
"type": "boolean"
},
"shared-secret": {
"description": "Deprecated. Please use client-secret.",
"env": "SHOPIFY_FLAG_SHARED_SECRET",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "shared-secret",
"required": false,
"type": "option"
},
"topic": {
"description": "The requested webhook topic.",
"env": "SHOPIFY_FLAG_TOPIC",
"hasDynamicHelp": false,
"hidden": false,
"multiple": false,
"name": "topic",
"required": false,
"type": "option"
}
},
"hasDynamicHelp": false,
"hiddenAliases": [
],
"id": "app:webhook:trigger",
"isESM": true,
"pluginAlias": "@shopify/app",
"pluginName": "@shopify/app",
"pluginType": "core",
"relativePath": [
"dist",
"cli",
"commands",
"app",
"webhook",
"trigger.js"
],
"strict": true,
"summary": "Trigger delivery of a sample webhook topic payload to a designated address.",
"usage": "shopify webhook trigger [flags]"
},
"webhook:trigger": {
"aliases": [
],
Expand Down Expand Up @@ -2081,6 +2184,7 @@
}
},
"hasDynamicHelp": false,
"hidden": true,
"hiddenAliases": [
],
"id": "webhook:trigger",
Expand All @@ -2095,7 +2199,6 @@
"webhook",
"trigger.js"
],
"strict": true,
"summary": "Trigger delivery of a sample webhook topic payload to a designated address.",
"usage": "shopify webhook trigger [flags]"
}
Expand Down
136 changes: 68 additions & 68 deletions packages/cli/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@
* [`shopify app init`](#shopify-app-init)
* [`shopify shopify app release --version <version>`](#shopify-shopify-app-release---version-version)
* [`shopify app versions list [FILE]`](#shopify-app-versions-list-file)
* [`shopify shopify webhook trigger [flags]`](#shopify-shopify-webhook-trigger-flags)
* [`shopify auth logout`](#shopify-auth-logout)
* [`shopify commands`](#shopify-commands)
* [`shopify shopify config autocorrect off`](#shopify-shopify-config-autocorrect-off)
Expand Down Expand Up @@ -65,7 +66,6 @@ shopify theme push --unpublished --json
* [`shopify theme share`](#shopify-theme-share)
* [`shopify upgrade`](#shopify-upgrade)
* [`shopify version`](#shopify-version)
* [`shopify shopify webhook trigger [flags]`](#shopify-shopify-webhook-trigger-flags)

## `shopify app build`

Expand Down Expand Up @@ -613,6 +613,73 @@ EXAMPLES

_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.57.0/dist/cli/commands/app/versions/list.js)_

## `shopify shopify webhook trigger [flags]`

Trigger delivery of a sample webhook topic payload to a designated address.

```
USAGE
$ shopify app webhook trigger shopify webhook trigger [flags]
FLAGS
--address=<value>
The URL where the webhook payload should be sent.
You will need a different address type for each delivery-method:
· For remote HTTP testing, use a URL that starts with https://
· For local HTTP testing, use http://localhost:{port}/{url-path}
· For Google Pub/Sub, use pubsub://{project-id}:{topic-id}
· For Amazon EventBridge, use an Amazon Resource Name (ARN) starting with arn:aws:events:
--api-version=<value>
The API Version of the webhook topic.
--client-secret=<value>
Your app's client secret. This secret allows us to return the X-Shopify-Hmac-SHA256 header that lets you validate
the origin of the response that you receive.
--delivery-method=<option>
Method chosen to deliver the topic payload. If not passed, it's inferred from the address.
<options: http|google-pub-sub|event-bridge>
--help
This help. When you run the trigger command the CLI will prompt you for any information that isn't passed using
flags.
--shared-secret=<value>
Deprecated. Please use client-secret.
--topic=<value>
The requested webhook topic.
DESCRIPTION
Trigger delivery of a sample webhook topic payload to a designated address.
Triggers the delivery of a sample Admin API event topic payload to a designated address.
You should use this command to experiment with webhooks, to initially test your webhook configuration, or for unit
testing. However, to test your webhook configuration from end to end, you should always trigger webhooks by performing
the related action in Shopify.
Because most webhook deliveries use remote endpoints, you can trigger the command from any directory where you can use
Shopify CLI, and send the webhook to any of the supported endpoint types. For example, you can run the command from
your app's local directory, but send the webhook to a staging environment endpoint.
To learn more about using webhooks in a Shopify app, refer to "Webhooks overview"
(https://shopify.dev/docs/apps/webhooks).
### Limitations
- Webhooks triggered using this method always have the same payload, so they can't be used to test scenarios that
differ based on the payload contents.
- Webhooks triggered using this method aren't retried when they fail.
- Trigger requests are rate-limited using the "Partner API rate limit"
(https://shopify.dev/docs/api/partner#rate_limits).
- You can't use this method to validate your API webhook subscriptions.
```

_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.57.0/dist/cli/commands/app/webhook/trigger.js)_

## `shopify auth logout`

Logs you out of the Shopify account or Partner account and store.
Expand Down Expand Up @@ -1599,71 +1666,4 @@ DESCRIPTION
```
_See code: [dist/cli/commands/version.js](https://github.com/Shopify/cli/edit/main/packages/cli/blob/v3.57.0/dist/cli/commands/version.js)_
## `shopify shopify webhook trigger [flags]`
Trigger delivery of a sample webhook topic payload to a designated address.
```
USAGE
$ shopify webhook trigger shopify webhook trigger [flags]

FLAGS
--address=<value>
The URL where the webhook payload should be sent.
You will need a different address type for each delivery-method:
· For remote HTTP testing, use a URL that starts with https://
· For local HTTP testing, use http://localhost:{port}/{url-path}
· For Google Pub/Sub, use pubsub://{project-id}:{topic-id}
· For Amazon EventBridge, use an Amazon Resource Name (ARN) starting with arn:aws:events:

--api-version=<value>
The API Version of the webhook topic.

--client-secret=<value>
Your app's client secret. This secret allows us to return the X-Shopify-Hmac-SHA256 header that lets you validate
the origin of the response that you receive.

--delivery-method=<option>
Method chosen to deliver the topic payload. If not passed, it's inferred from the address.
<options: http|google-pub-sub|event-bridge>

--help
This help. When you run the trigger command the CLI will prompt you for any information that isn't passed using
flags.

--shared-secret=<value>
Deprecated. Please use client-secret.

--topic=<value>
The requested webhook topic.

DESCRIPTION
Trigger delivery of a sample webhook topic payload to a designated address.


Triggers the delivery of a sample Admin API event topic payload to a designated address.

You should use this command to experiment with webhooks, to initially test your webhook configuration, or for unit
testing. However, to test your webhook configuration from end to end, you should always trigger webhooks by performing
the related action in Shopify.

Because most webhook deliveries use remote endpoints, you can trigger the command from any directory where you can use
Shopify CLI, and send the webhook to any of the supported endpoint types. For example, you can run the command from
your app's local directory, but send the webhook to a staging environment endpoint.

To learn more about using webhooks in a Shopify app, refer to "Webhooks overview"
(https://shopify.dev/docs/apps/webhooks).

### Limitations

- Webhooks triggered using this method always have the same payload, so they can't be used to test scenarios that
differ based on the payload contents.
- Webhooks triggered using this method aren't retried when they fail.
- Trigger requests are rate-limited using the "Partner API rate limit"
(https://shopify.dev/docs/api/partner#rate_limits).
- You can't use this method to validate your API webhook subscriptions.
```
_See code: [@shopify/app](https://github.com/Shopify/cli/edit/main/packages/app/blob/v3.57.0/dist/cli/commands/webhook/trigger.js)_
<!-- commandsstop -->
26 changes: 26 additions & 0 deletions packages/cli/oclif.manifest.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -193,6 +193,32 @@
],
"strict": true
},
"docs:generate": {
"aliases": [
],
"args": {
},
"description": "Generate CLI commands documentation",
"flags": {
},
"hasDynamicHelp": false,
"hidden": true,
"hiddenAliases": [
],
"id": "docs:generate",
"isESM": true,
"pluginAlias": "@shopify/cli",
"pluginName": "@shopify/cli",
"pluginType": "core",
"relativePath": [
"dist",
"cli",
"commands",
"docs",
"generate.js"
],
"strict": true
},
"hydrogen:init": {
"aliases": [
],
Expand Down

0 comments on commit 2902072

Please sign in to comment.