Update webhook by ID
Update a specific webhook by the given webhook ID.
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Merchant's 24-character tenant ID
Sales channel ID
Unique request ID
Path Parameters
Webhook ID to identify the webhook
Body
Target URL to which the webhook sends event message when a subscribed event is modified
API key of the target service, if authentication is required
Custom header list. These data will be sent to target
.
Protocol used while triggering the webhook
HTTP
Source of event trigger
Content-type of request body while triggering the webhook
Events subscription. When the subscribed event is modified, the webhook sends a notification message to the target
.
CROSS_BORDER_VALIDATION
, ORDER_CREATE
, ORDER_HOLD_CROSSBORDER
, ORDER_HOLD_FRAUD
, ORDER_HOLD_CSR
, ORDER_CONFIRMED
, ORDER_IN_PROGRESS
, ORDER_CANCEL
, ORDER_EXCHANGE
, FRAUD_CANCEL
, FRAUD_RELEASE
, ORDER_PARTIALLY_RETURNED
, RETURN_PENDING
, RETURN_PROCESSING
, RETURN_REJECTED
, ORDER_CANCELLED
, ORDER_PARTIALLY_CANCELLED
, ORDER_RETURNED
, ORDER_SHIPPED
, EXCHANGE_PENDING
, EXCHANGE_TO_SHIPMENT
, SINGLE_ITEM_ORDER_CONFIRMATION_EMAIL
, MULTI_ITEM_ORDER_CONFIRMATION_EMAIL
, BOPIS_ORDER_CONFIRMATION_EMAIL
, SHIPPING_CONFIRMATION_EMAIL
, BOPIS_ORDER_READY_FOR_PICKUP
, BOPIS_ORDER_COMPLETED
, BOPIS_REMINDER_EMAIL
, BACKORDER_NOTIFICATION_EMAIL
, BACKORDER_30_DAYS_CONSENT_TO_DELAY_EMAIL
, BACKORDER_53_DAYS_CONSENT_TO_DELAY_EMAIL
, BACKORDER_CANCEL_EMAIL
, BACKORDER_AUTH_DECLINE_EMAIL
, ORDER_CANCELLATION_EMAIL_WEBCSC_ORDER_ITEM_CANCEL
, ORDER_CANCELLATION_EMAIL_WEBCSC_ORDER_CANCEL
, ORDER_CANCELLATION_EMAIL_LOCATE_ORDER_ITEM_CANCEL
, RETURN_NOTIFICATION_EMAIL
, REFUND_NOTIFICATION_EMAIL
, APPEASEMENT_NOTIFICATION_EMAIL
, ORDER_CREATE_IN_PTS
, ORDER_CANCELLED_IN_PTS
, SHIPMENT_CREATE_IN_PTS
, SHIPMENT_CANCELLED_IN_PTS
, RETURN_LPN
, ALLOCATION_CREATE
, ALLOCATION_DC
, ALLOCATION_CREATE_SDD
, ALLOCATION_CREATE_BOPIS
, ALLOCATION_CREATE_SHIP
, ALLOCATION_CREATE_GIFTCARD
, TRANSFER_CREATE
, ALLOCATION_CREATE_INTERNATIONAL
, SHIPMENT_CREATED
, SHIPMENT_CANCELLED
, GIFTCARD_ACTIVATE
, PICKUP_CREATED
, PICKUP_COMPLETED
, SHIPMENT_UPDATE
, INVOICE_POSTING
, INVENTORY_CREATE
, INVENTORY_UPDATE
, INVENTORY_BULK
, INVENTORY_NETWORK_UPDATED
, INVENTORY_NETWORK_AGGREGATION
, LIST_UPDATE
, EXPORT_ORDER_INITIATED
, EXPORT_ORDER_COMPLETED
, EXPORT_ORDER_ERROR
, EXPORT_ALLOCATION_INITIATED
, EXPORT_ALLOCATION_COMPLETED
, EXPORT_ALLOCATION_ERROR
, EXPORT_SHIPMENT_INITIATED
, EXPORT_SHIPMENT_COMPLETED
, EXPORT_SHIPMENT_ERROR
, EXPORT_INVOICE_INITIATED
, EXPORT_INVOICE_COMPLETED
, EXPORT_INVOICE_ERROR
, EXPORT_LOCATION_INITIATED
, EXPORT_LOCATION_COMPLETED
, EXPORT_LOCATION_ERROR
, EXPORT_INVENTORY_INITIATED
, EXPORT_INVENTORY_COMPLETED
, EXPORT_INVENTORY_ERROR
, EXPORT_NETWORK_INITIATED
, EXPORT_NETWORK_COMPLETED
, EXPORT_NETWORK_ERROR
, EXPORT_SHIPPING_METHODS_INITIATED
, EXPORT_SHIPPING_METHODS_COMPLETED
, EXPORT_SHIPPING_METHODS_ERROR
, EXPORT_AGGREGATED_NETWORK_INITIATED
, EXPORT_AGGREGATED_NETWORK_COMPLETED
, EXPORT_AGGREGATED_NETWORK_ERROR
, CREDIT_CONFIRMED
, CREDIT_PENDING
, CREDIT_FAILED
, CREDIT_CANCELED
Type of HTTP method used when triggering an event to the target
POST
, PUT
, PATCH
, GET
, DELETE
Response
Unique webhook ID to identify the webhook
Merchant's 24 character tenant ID
Target URL to which the webhook sends event message when a subscribed event is modified
API key of the target service, if authentication is required
Custom header list. These data will be sent to target
.
Protocol used while triggering the webhook
HTTP
Source of event trigger
Content-type of request body while triggering the webhook
Date and time when the webhook was created
Date and time when the webhook was last updated
Events subscription. When the subscribed event is modified, the webhook sends a notification message to the target
.
CROSS_BORDER_VALIDATION
, ORDER_CREATE
, ORDER_HOLD_CROSSBORDER
, ORDER_HOLD_FRAUD
, ORDER_HOLD_CSR
, ORDER_CONFIRMED
, ORDER_IN_PROGRESS
, ORDER_CANCEL
, ORDER_EXCHANGE
, FRAUD_CANCEL
, FRAUD_RELEASE
, ORDER_PARTIALLY_RETURNED
, RETURN_PENDING
, RETURN_PROCESSING
, RETURN_REJECTED
, ORDER_CANCELLED
, ORDER_PARTIALLY_CANCELLED
, ORDER_RETURNED
, ORDER_SHIPPED
, EXCHANGE_PENDING
, EXCHANGE_TO_SHIPMENT
, SINGLE_ITEM_ORDER_CONFIRMATION_EMAIL
, MULTI_ITEM_ORDER_CONFIRMATION_EMAIL
, BOPIS_ORDER_CONFIRMATION_EMAIL
, SHIPPING_CONFIRMATION_EMAIL
, BOPIS_ORDER_READY_FOR_PICKUP
, BOPIS_ORDER_COMPLETED
, BOPIS_REMINDER_EMAIL
, BACKORDER_NOTIFICATION_EMAIL
, BACKORDER_30_DAYS_CONSENT_TO_DELAY_EMAIL
, BACKORDER_53_DAYS_CONSENT_TO_DELAY_EMAIL
, BACKORDER_CANCEL_EMAIL
, BACKORDER_AUTH_DECLINE_EMAIL
, ORDER_CANCELLATION_EMAIL_WEBCSC_ORDER_ITEM_CANCEL
, ORDER_CANCELLATION_EMAIL_WEBCSC_ORDER_CANCEL
, ORDER_CANCELLATION_EMAIL_LOCATE_ORDER_ITEM_CANCEL
, RETURN_NOTIFICATION_EMAIL
, REFUND_NOTIFICATION_EMAIL
, APPEASEMENT_NOTIFICATION_EMAIL
, ORDER_CREATE_IN_PTS
, ORDER_CANCELLED_IN_PTS
, SHIPMENT_CREATE_IN_PTS
, SHIPMENT_CANCELLED_IN_PTS
, RETURN_LPN
, ALLOCATION_CREATE
, ALLOCATION_DC
, ALLOCATION_CREATE_SDD
, ALLOCATION_CREATE_BOPIS
, ALLOCATION_CREATE_SHIP
, ALLOCATION_CREATE_GIFTCARD
, TRANSFER_CREATE
, ALLOCATION_CREATE_INTERNATIONAL
, SHIPMENT_CREATED
, SHIPMENT_CANCELLED
, GIFTCARD_ACTIVATE
, PICKUP_CREATED
, PICKUP_COMPLETED
, SHIPMENT_UPDATE
, INVOICE_POSTING
, INVENTORY_CREATE
, INVENTORY_UPDATE
, INVENTORY_BULK
, INVENTORY_NETWORK_UPDATED
, INVENTORY_NETWORK_AGGREGATION
, LIST_UPDATE
, EXPORT_ORDER_INITIATED
, EXPORT_ORDER_COMPLETED
, EXPORT_ORDER_ERROR
, EXPORT_ALLOCATION_INITIATED
, EXPORT_ALLOCATION_COMPLETED
, EXPORT_ALLOCATION_ERROR
, EXPORT_SHIPMENT_INITIATED
, EXPORT_SHIPMENT_COMPLETED
, EXPORT_SHIPMENT_ERROR
, EXPORT_INVOICE_INITIATED
, EXPORT_INVOICE_COMPLETED
, EXPORT_INVOICE_ERROR
, EXPORT_LOCATION_INITIATED
, EXPORT_LOCATION_COMPLETED
, EXPORT_LOCATION_ERROR
, EXPORT_INVENTORY_INITIATED
, EXPORT_INVENTORY_COMPLETED
, EXPORT_INVENTORY_ERROR
, EXPORT_NETWORK_INITIATED
, EXPORT_NETWORK_COMPLETED
, EXPORT_NETWORK_ERROR
, EXPORT_SHIPPING_METHODS_INITIATED
, EXPORT_SHIPPING_METHODS_COMPLETED
, EXPORT_SHIPPING_METHODS_ERROR
, EXPORT_AGGREGATED_NETWORK_INITIATED
, EXPORT_AGGREGATED_NETWORK_COMPLETED
, EXPORT_AGGREGATED_NETWORK_ERROR
, CREDIT_CONFIRMED
, CREDIT_PENDING
, CREDIT_FAILED
, CREDIT_CANCELED
Type of HTTP method used when triggering an event to the target
POST
, PUT
, PATCH
, GET
, DELETE
Was this page helpful?