Webhooks config issue in `shopify.app.toml`

[Xmaster6y]

TL;DR

Impossible to deploy a config with /webhooks URI or with both compliance and regular topics.

The Problems

/webhooks

The config I'm used to use:

[webhooks]
api_version = "2025-01"

  [[webhooks.subscriptions]]
  topics = [ "app_subscriptions/update", "app/uninstalled" ]
  uri = "/webhooks"
  compliance_topics = [ "customers/data_request", "customers/redact", "shop/redact" ]

Yields the error:

╭─ error ──────────────────────────────────────────────────────────────────────╮
│                                                                              │
│  App configuration is not valid                                              │
│  Validation errors in shopify.app.dev.toml:                                  │
│                                                                              │
│  • [webhooks.subscriptions.0.uri]: URI isn't correct URI format of           │
│  https://, pubsub://{project}:topic or Eventbridge ARN                       │
│                                                                              │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯

Https

The config:

[webhooks]
api_version = "2025-01"

  [[webhooks.subscriptions]]
  topics = [ "app_subscriptions/update", "app/uninstalled" ]
  uri = "https://programming-neighbor-we-transmit.trycloudflare.com/webhooks"
  compliance_topics = [ "customers/data_request", "customers/redact", "shop/redact" ]

Yields the error:

╭─ error ──────────────────────────────────────────────────────────────────────╮
│                                                                              │
│  Version couldn't be created.                                                │
│                                                                              │
│  webhooks                                                                    │
│                                                                              │
│  Validation errors                                                           │
│    • Unexpected key(s) were found.                                           │
│                                                                              │
╰──────────────────────────────────────────────────────────────────────────────╯

same for:

[webhooks]
api_version = "2025-01"

  [[webhooks.subscriptions]]
  topics = [ "app_subscriptions/update", "app/uninstalled" ]
  uri = "https://programming-neighbor-we-transmit.trycloudflare.com/webhooks"

  [[webhooks.subscriptions]]
  uri = "https://programming-neighbor-we-transmit.trycloudflare.com/webhooks"
  compliance_topics = [ "customers/data_request", "customers/redact", "shop/redact" ]

What works

The configs that work:

[webhooks]
api_version = "2025-01"

  [[webhooks.subscriptions]]
  uri = "https://programming-neighbor-we-transmit.trycloudflare.com/webhooks"
  compliance_topics = [ "customers/data_request", "customers/redact", "shop/redact" ]

[NyashaMadzokere]

Hi.Did you win on this? Facing similar error, even after generating new app

[Xmaster6y]

Didn't dig more atm. But it might be an issue for https://github.com/Shopify/cli. Feel free to dig a link this issue there.

[lizkenyon]

Hi there 👋

I am going to transfer this issue to the CLI team, as they are the ones doing the validation. It would most likely be helpful for their debugging if you are able to share your Shopify CLI version.

[gonzaloriestra]

Hi! Sorry for the late response.

Looking at the error messages, it seems that you are using an old version of the CLI. Could you please upgrade it and try again?

[Xmaster6y]

Thank you, that was it (feel dumb). I had a globally installed cli (and not a local devDep).