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

Commit

Permalink
DEVDOCS-5491: [update] add status (#1493)
Browse files Browse the repository at this point in the history
  • Loading branch information
bc-traciporter authored Oct 12, 2023
1 parent 6782cd8 commit 62e6a62
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions reference/webhooks.v3.yml
Original file line number Diff line number Diff line change
Expand Up @@ -227,14 +227,21 @@ paths:
description: You can pass in any number of custom headers to validate webhooks being returned.
is_active:
type: boolean
description: If webhook is active or not
description: If the webhook is active or not.
default: true
created_at:
type: integer
description: Created time
updated_at:
type: integer
description: Updated time
status:
type: string
description: The webhook status.
enum:
- inactive
- active
- deactivated
blocked_domains:
description: List of domains (destinations) that are currently on the denylist and are not being sent webhooks.
type: array
Expand Down Expand Up @@ -732,8 +739,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 @@ -1419,7 +1426,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 title="Example callback object" lineNumbers
Expand Down

0 comments on commit 62e6a62

Please sign in to comment.