Understanding Webhook Events
In any system that uses webhooks, understanding the different events that trigger these webhooks is crucial. Below, we detail the specific webhook events supported by our platform and the data they convey.
User Events
-
user.creation
: Triggered when a new user is registered.
Description: Notifies when a new user account is created. -
user.update
: Triggered when user information is updated.
Description: Notifies when any user profile details are changed. -
user.delete
: Triggered when a user account is deleted.
Description: Notifies when a user account is permanently removed.
Listing Events
-
listing.creation
: Triggered when a new listing is created.
Description: Notifies when a new listing is added to the platform. -
listing.update
: Triggered when an existing listing is updated.
Description: Notifies when any details of a listing are modified. -
listing.delete
: Triggered when a listing is deleted.
Description: Notifies when a listing is removed from the platform.
Order Events
-
order.status.draft
: Indicates an order has been initiated but not yet completed.
Description: Used for orders that are started but not submitted. -
order.status.pending
: Triggered when an order is pending approval.
Description: Indicates waiting for some form of confirmation or processing. -
order.status.new
: Triggered when an order is paid and validated by the customer.
Description: Signifies that payment has been received and the order is validated. -
order.status.accepted
: Triggered when an order is accepted by the vendor.
Description: Notifies that the vendor has confirmed the order details. -
order.status.shipped
: Triggered when an order is shipped.
Description: Indicates that the order has been dispatched to the customer. -
order.status.service_provided
: Triggered when a service is provided by the vendor.
Description: Notifies completion of a service-related order. -
order.status.customer_confirmed
: Triggered when an order is received by the customer.
Description: Confirms that the customer has received the order. -
order.status.declined
: Triggered when an order is refused by the vendor.
Description: Indicates a vendor’s refusal or inability to fulfill an order. -
order.status.completed
: Triggered when an order is completed.
Description: Marks the successful conclusion of an order transaction. -
order.status.failed
: Triggered when an order processing fails.
Description: Used when there is a failure in processing the order. -
order.status.canceled
: Triggered when an order is canceled.
Description: Indicates that an order has been canceled by the customer or due to other reasons. -
order.delete
: Triggered when an order is deleted.
Description: Notifies when an order record is removed from the platform.
Each of these events is designed to facilitate real-time integration and automation, making your workflows more efficient and responsive to changes. By utilizing these webhook events, you can set up a highly interactive system that keeps all stakeholders informed about critical activities and changes.