djkato/saleor-app-sdk-REDIS_APL
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Mark query in manifest required (#280)

Browse source 
* Mark query in manifest required

* Update tender-news-do.md
This commit is contained in:
Lukasz Ostrowski 2023-09-06 09:30:56 +02:00 committed by GitHub
parent 64e97ffb2b
commit 3e31b3a42f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 22 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
.changeset/tender-news-do.md Normal file
View file

@ -0,0 +1,11 @@
---
"@saleor/app-sdk": patch
---
Changed the "query" field in the AppManifest webhook to be required. Previously, this field was optional.
For subscription events, Saleor rejects webhooks without query, so this field was valid only with legacy non-subscription webhooks.
Now, the query is obligatory.
Warning: This can be a breaking change for some scenarios where legacy webhooks were used!

13
src/types.ts
View file

@ -213,8 +213,17 @@ export interface WebhookManifest {
name: string;
asyncEvents?: AsyncWebhookEventType[];
syncEvents?: SyncWebhookEventType[];
/** If query is not provided, the default webhook payload will be used */
query?: string;
/**
* Query is required for a subscription.
* If you don't need a payload, you can provide empty query like this:
*
* subscription {
* event {
* __typename
* }
* }
*/
query: string;
/** The full URL of the endpoint where request will be sent */
targetUrl: string;
isActive?: boolean;