Skip to content
This repository has been archived by the owner on Jan 15, 2024. It is now read-only.

(no ticket): [external] Webhooks, create webhook_Put schema without required fields #1241

Merged
merged 13 commits into from
Dec 26, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 29 additions & 1 deletion reference/webhooks.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ paths:
content:
application/json:
schema:
$ref: '#/components/schemas/webhook_Base'
$ref: '#/components/schemas/webhook_Put'
x-examples:
application/json:
scope: store/cart/lineItem/*
Expand Down Expand Up @@ -3026,6 +3026,34 @@ components:
errors:
type: object
x-internal: false
webhook_Put:
type: object
title: webhook_Put
x-internal: false
properties:
scope:
type: string
example: store/order/*
description: Event you subscribe to.
destination:
type: string
example: 'https://665b65a6.ngrok.io/webhooks'
description: URL must be active, return a 200 response, and be served on port 443. Custom ports arenʼt currently supported.
is_active:
type: boolean
example: true
description: Boolean value that indicates whether the webhook is active or not.
events_history_enabled:
type: boolean
example: true
description: Boolean value that identifies whether events are stored that could not be received.
headers:
type: object
description: Headers used to validate that webhooks are active. You can pass in any number of custom headers to validate webhooks are being returned.
nullable: true
properties: {}
additionalProperties:
type: string
webhook_Base:
type: object
title: webhook_Base
Expand Down
Loading