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

Commit

Permalink
(no ticket): [external] Webhooks, fix header field to indicate suppor…
Browse files Browse the repository at this point in the history 
…t for custom key-value pairs (#1233)

Co-authored-by: Sarah Riehl <[email protected]>
  • Loading branch information
@kzhang-dsg
kzhang-dsg and Sarah Riehl authored Dec 26, 2023
1 parent e8d2814 commit 13ca969
Showing 1 changed file with 34 additions and 22 deletions.
56 changes: 34 additions & 22 deletions reference/webhooks.v3.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ openapi: '3.0.3'
info:
title: Webhooks v3
version: ''
description: 'Get notified when specific events occur on a BigCommerce store. For more information, see [Webhooks Overview](/docs/integrations/webhooks).'
description: 'Get notified when specific events occur on a BigCommerce store. For more information, see the [Webhooks Overview](/docs/integrations/webhooks).'
termsOfService: 'https://www.bigcommerce.com/terms'
contact:
email: [email protected]
Expand Down Expand Up @@ -53,7 +53,7 @@ paths:
destination: 'https://665b65a6.ngrok.io/webhooks'
is_active: true
headers:
custom: string
'custom-key': developer-defined value
meta:
pagination:
count: 5
Expand Down Expand Up @@ -164,7 +164,7 @@ paths:
'200':
$ref: '#/components/responses/webhook_Resp'
summary: Delete a Webhook
description: 'Deletes a webhook. Only one webhook at a time can be deleted. When a webhook is deleted, it is returned in the response as a 200 OK.'
description: Deletes a webhook. Only one webhook at a time can be deleted. When a webhook is deleted, it is returned in the response as a 200 OK.
operationId: deleteAWebhook
tags:
- Manage Webhooks (Single)
Expand All @@ -175,7 +175,7 @@ paths:
get:
operationId: getHooksAdmin
summary: Get Admin Info
description: 'List all notification emails, webhooks, and denylisted domains associated with the API account.'
description: List all notification emails, webhooks, and denylisted domains associated with the API account.
parameters:
- $ref: '#/components/parameters/IsActive'
responses:
Expand All @@ -197,7 +197,7 @@ paths:
format: email
example: '[email protected]'
hooks_list:
description: 'List of all the webhooks associated with the provider API account, filtered by the "active" parameter.'
description: 'List of all the webhooks associated with the provider API account, filtered by the `active` parameter.'
type: array
items:
type: object
Expand All @@ -208,7 +208,7 @@ paths:
client_id:
type: string
minLength: 1
description: 'Client ID, unique to the store or app.'
description: Client ID, unique to the store or app.
store_hash:
minLength: 1
type: string
Expand All @@ -221,10 +221,14 @@ paths:
destination:
type: string
minLength: 1
description: 'URL must be active, return a 200 response, and be served on port 443 (custom ports not currently supported)'
description: URL must be active, return a 200 response, and be served on port 443. Custom ports arenʼt currently supported.
headers:
type: object
description: You can pass in any number of custom headers to validate webhooks being returned.
properties: {}
nullable: true
additionalProperties:
type: string
is_active:
type: boolean
description: If the webhook is active or not. A webhook subscription becomes deactivated after 90 days of inactivity.
Expand Down Expand Up @@ -460,7 +464,10 @@ components:
minLength: 1
headers:
type: object
properties: {}
nullable: true
additionalProperties:
type: string
is_active:
type: boolean
created_at:
Expand All @@ -474,7 +481,7 @@ components:
$ref: '#/components/schemas/Pagination'
examples: {}
502_GatewayError:
description: 'If something happens during the request that causes it to fail, a 502 response will be returned. A new request should be made; however, it could fail.'
description: If something happens during the request that causes it to fail, a 502 response will be returned. A new request should be made; however, it could fail.
content:
application/json:
schema:
Expand Down Expand Up @@ -548,7 +555,7 @@ components:
title: Unauthorized Access. You do not have permission to make this request.
type: /api-docs/getting-started/api-status-codes
404_NotFound:
description: 'If the requested webhook is not found, return a 404 Not Found.'
description: If the requested webhook is not found, return a 404 Not Found.
content:
application/json:
schema:
Expand Down Expand Up @@ -611,7 +618,12 @@ components:
destination:
type: string
minLength: 1
headers: {}
headers:
type: object
properties: {}
nullable: true
additionalProperties:
type: string
is_active:
type: boolean
created_at:
Expand All @@ -636,7 +648,7 @@ components:
destination: 'https://665b65a6.ngrok.io/webhooks'
is_active: true
headers:
custom: string
'custom-key': developer-defined value
meta:
pagination:
count: 5
Expand Down Expand Up @@ -739,8 +751,8 @@ components:
title: store/cart/updated
description: |-
Fires when one of the following occurs:
* A cart's line items are modified by adding a new item to a cart, updating an existing item's quantity, or deleting an item.
* A shopper enters or changes their email address during guest checkout. This includes signing in to a customer account after creating a guest cart, which associates the account's email address with the cart.
* A cartʼs line items are modified by adding a new item to a cart, updating an existing itemʼs quantity, or deleting an item.
* A shopper enters or changes their email address during guest checkout. This includes signing in to a customer account after creating a guest cart, which associates the accountʼs email address with the cart.
The `store/cart/created` webhook firing also triggers this webhook because adding a product to an empty cart is considered an update.
Expand Down Expand Up @@ -1426,7 +1438,7 @@ components:
store_customer_updated:
title: store/customer/updated
description: |-
This webhook is triggered when a customer is updated. In addition, this webhook is triggered when a shopper initially enters custom form field values within the account sign-up form. Please note that neither changing existing data in customer form fields nor changing a customer's address will trigger the webhook.
This webhook is triggered when a customer is updated. In addition, this webhook is triggered when a shopper initially enters custom form field values within the account sign-up form. Please note that neither changing existing data in customer form fields nor changing a customerʼs address will trigger the webhook.
```json filename="Example callback object" showLineNumbers
Expand Down Expand Up @@ -2134,7 +2146,7 @@ components:
* Product URL
* Set as a Featured Product on my Storefront
However, changes to the following fields don't trigger this event:
However, changes to the following fields donʼt trigger this event:
* Manufacturer Part Number (MPN)
* Global Trade Number (GTN)
Expand Down Expand Up @@ -2188,7 +2200,7 @@ components:
Changes to the following fields trigger this event:
* Inventory Stock
However, changes to the following fields don't trigger this event:
However, changes to the following fields donʼt trigger this event:
* Track Inventory
* Inventory Low Stock
Expand Down Expand Up @@ -3026,7 +3038,7 @@ components:
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 not currently supported).'
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
Expand All @@ -3038,11 +3050,11 @@ components:
deprecated: true
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. '
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:
custom:
type: string
properties: {}
additionalProperties:
type: string
required:
- scope
- destination
Expand All @@ -3057,7 +3069,7 @@ components:
example: 18048287
client_id:
type: string
description: 'Client ID, unique to the store or app.'
description: Client ID, unique to the store or app.
example: m9r6keqmo7h7f23btnpwernbez1kglkl
store_hash:
type: string
Expand Down

0 comments on commit 13ca969

Please sign in to comment.