DEVDOCS-6049: [update] update webhooks yml file #770
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Comment on lines
+692
to
+693
| errors: | ||
| type: object |
There was a problem hiding this comment.
🚫 [spectral] reported by reviewdog 🐶
type: object must have a properties sibling.
Comment on lines
+753
to
+774
| - title: webhook_Full | ||
| properties: | ||
| data: | ||
| type: object | ||
| description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. | ||
| properties: | ||
| type: | ||
| type: string | ||
| description: can be `cart` or `cart_line_item` | ||
| example: cart | ||
| id: | ||
| type: string | ||
| description: ID of the cart | ||
| example: 09346904-4175-44fd-be53-f7e598531b6c | ||
| couponId: | ||
| type: integer | ||
| description: ID of the coupon | ||
| example: 1 | ||
| x-tags: | ||
| - created | ||
| x-internal: false | ||
| store_cart_abandoned: | ||
| title: store/cart/abandoned | ||
| description: |- | ||
| This webhook fires after a cart is abandoned. BigCommerce considers a cart abandoned when it has no activity for at least one hour. This webhook is available for all store plans, regardless of whether the Abandoned Cart Saver feature is enabled. | ||
|
|
||
| ```json filename="Example callback object" showLineNumbers | ||
| { | ||
| "created_at": 1561482670, | ||
| "store_id": "1025646", | ||
| "producer": "stores/{store_hash}", | ||
| "scope": "store/cart/abandoned", | ||
| "hash": "352e4afc6dd3fc85ea26bfdf3f91852604d57528", | ||
| "data": { | ||
| "type": "cart", | ||
| "id": "09346904-4175-44fd-be53-f7e598531b6c", | ||
| "token": "1eed6d2d979776ff18e695ceeb10ea61" | ||
| } | ||
| } | ||
| ``` | ||
| allOf: | ||
| - $ref: '#/components/schemas/webhook_callback_base' | ||
| - type: object | ||
| id: | ||
| type: integer | ||
| description: ID of the webhook. | ||
| example: 18048287 | ||
| client_id: | ||
| type: string | ||
| description: Client ID, unique to the store or app. | ||
| example: m9r6keqmo7h7f23btnpwernbez1kglkl | ||
| store_hash: | ||
| type: string | ||
| description: Permanent ID of the BigCommerce store. | ||
| example: sftg45fsd | ||
| created_at: | ||
| type: integer | ||
| example: 1561488106 | ||
| description: The time the webhook was created, represented in UNIX epoch time. | ||
| updated_at: | ||
| type: integer | ||
| example: 1561488106 | ||
| description: The time the webhook was most recently updated, represented in UNIX epoch time. |
There was a problem hiding this comment.
🚫 [spectral] reported by reviewdog 🐶
Objects with properties must have type: object.
Comment on lines
+785
to
787
| data: | ||
| type: object | ||
| description: A lightweight description of the event that triggered the webhook. Will vary depending on the event registered. |
There was a problem hiding this comment.
🚫 [spectral] reported by reviewdog 🐶
type: object must have a properties sibling.
Comment on lines
+831
to
+869
| description: Permanent ID of the BigCommerce store. | ||
| example: sftg45fsd | ||
| - properties: | ||
| created_at: | ||
| type: integer | ||
| example: 1561488106 | ||
| description: The time the webhook was created, represented in UNIX epoch time. | ||
| updated_at: | ||
| type: integer | ||
| example: 1561488106 | ||
| description: The time the webhook was most recently updated, represented in UNIX epoch time. | ||
| Pagination: | ||
| type: object | ||
| description: | | ||
| Data about the response, including pagination and collection totals. | ||
| properties: | ||
| total: | ||
| type: integer | ||
| description: Total number of returned items across all pages. | ||
| count: | ||
| type: integer | ||
| description: Number of items on current page. | ||
| per_page: | ||
| type: integer | ||
| description: Maximum number of items per page. | ||
| current_page: | ||
| type: integer | ||
| description: Current page number. | ||
| total_pages: | ||
| type: integer | ||
| description: Total number of pages. | ||
| links: | ||
| type: object | ||
| properties: | ||
| previous: | ||
| readOnly: true | ||
| store_id: | ||
| type: string | ||
| description: Link to the previous page returned in the response. | ||
| current: | ||
| minLength: 1 | ||
| example: '1025646' | ||
| description: A numerical identifier that is unique to each store. | ||
| producer: | ||
| type: string | ||
| description: Link to the current page returned in the response. | ||
| next: | ||
| minLength: 1 | ||
| example: 'stores/{store_hash}' | ||
| description: Will always follow the pattern `stores/store_hash`. This is the store that created the webhook. | ||
| scope: | ||
| type: string | ||
| description: Link to the next page returned in the response. | ||
| x-internal: false | ||
| webhook_callback_base: | ||
| description: '' | ||
| x-examples: | ||
| example-1: | ||
| created_at: 1561482670 | ||
| store_id: '1025646' | ||
| producer: 'stores/{store_hash}' | ||
| scope: store/cart/created | ||
| hash: 352e4afc6dd3fc85ea26bfdf3f91852604d57528 | ||
| title: '' | ||
| minLength: 1 | ||
| example: store/cart/created | ||
| description: The event registered when the webhook was created. | ||
| hash: | ||
| type: string | ||
| minLength: 1 | ||
| example: 352e4afc6dd3fc85ea26bfdf3f91852604d57528 | ||
| description: The payload data encoded in JSON format and then passed through SH1 encryption. | ||
| type: object | ||
| properties: | ||
| created_at: | ||
| type: integer | ||
| example: 1561488106 | ||
| description: The time the webhook was created, represented in UNIX epoch time. | ||
| readOnly: true | ||
| store_id: | ||
| type: string | ||
| minLength: 1 | ||
| example: '1025646' | ||
| description: A numerical identifier that is unique to each store. | ||
| producer: | ||
| type: string | ||
| minLength: 1 | ||
| example: 'stores/{store_hash}' | ||
| description: Will always follow the pattern `stores/store_hash`. This is the store that created the webhook. | ||
| scope: | ||
| type: string | ||
| minLength: 1 | ||
| example: store/cart/created | ||
| description: The event registered when the webhook was created. | ||
| hash: | ||
| type: string | ||
| minLength: 1 | ||
| example: 352e4afc6dd3fc85ea26bfdf3f91852604d57528 | ||
| description: The payload data encoded in JSON format and then passed through SH1 encryption. | ||
| x-internal: false |
There was a problem hiding this comment.
🚫 [spectral] reported by reviewdog 🐶
type: object must have a properties sibling.
Comment on lines
+842
to
+867
| - properties: | ||
| created_at: | ||
| type: integer | ||
| example: 1561488106 | ||
| description: The time the webhook was created, represented in UNIX epoch time. | ||
| updated_at: | ||
| type: integer | ||
| example: 1561488106 | ||
| description: The time the webhook was most recently updated, represented in UNIX epoch time. | ||
| Pagination: | ||
| type: object | ||
| description: | | ||
| Data about the response, including pagination and collection totals. | ||
| properties: | ||
| total: | ||
| type: integer | ||
| description: Total number of returned items across all pages. | ||
| count: | ||
| type: integer | ||
| description: Number of items on current page. | ||
| per_page: | ||
| type: integer | ||
| description: Maximum number of items per page. | ||
| current_page: | ||
| type: integer | ||
| description: Current page number. | ||
| total_pages: | ||
| type: integer | ||
| description: Total number of pages. | ||
| links: | ||
| type: object | ||
| properties: | ||
| previous: | ||
| readOnly: true | ||
| store_id: | ||
| type: string | ||
| description: Link to the previous page returned in the response. | ||
| current: | ||
| minLength: 1 | ||
| example: '1025646' | ||
| description: A numerical identifier that is unique to each store. | ||
| producer: | ||
| type: string | ||
| description: Link to the current page returned in the response. | ||
| next: | ||
| minLength: 1 | ||
| example: 'stores/{store_hash}' | ||
| description: Will always follow the pattern `stores/store_hash`. This is the store that created the webhook. | ||
| scope: | ||
| type: string | ||
| description: Link to the next page returned in the response. | ||
| x-internal: false | ||
| webhook_callback_base: | ||
| description: '' | ||
| x-examples: | ||
| example-1: | ||
| created_at: 1561482670 | ||
| store_id: '1025646' | ||
| producer: 'stores/{store_hash}' | ||
| scope: store/cart/created | ||
| hash: 352e4afc6dd3fc85ea26bfdf3f91852604d57528 | ||
| title: '' | ||
| minLength: 1 | ||
| example: store/cart/created | ||
| description: The event registered when the webhook was created. | ||
| hash: | ||
| type: string | ||
| minLength: 1 | ||
| example: 352e4afc6dd3fc85ea26bfdf3f91852604d57528 | ||
| description: The payload data encoded in JSON format and then passed through SH1 encryption. |
There was a problem hiding this comment.
🚫 [spectral] reported by reviewdog 🐶
Objects with properties must have type: object.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DEVDOCS-6049
What changed?
Updated yml file
Release notes draft
Anything else?
ping {names}