Skip to main content
Create webhook subscription

Authorizations

X-API-Key
string
header
required

Body

application/json
destination_url
string<uri>
required
Minimum string length: 1
topic
enum<string>
required
  • customer_created - Customer Created
  • customer_updated - Customer Updated
  • customer_address_created - Customer Address Created
  • customer_address_updated - Customer Address Updated
  • customer_address_deleted - Customer Address Deleted
  • customer_approved - Customer Approved
  • customer_unapproved - Customer Unapproved
  • order_created - Order Created
  • order_approved - Order Approved
  • shipment_created - Shipment Created
  • order_terms_payment_created - Order Terms Payment Created
  • order_terms_payment_reversed - Order Terms Payment Reversed
  • order_terms_allowance_created - Order Terms Allowance Created
  • order_terms_allowance_reversed - Order Terms Allowance Reversed
  • order_refund_created - Order Refund Created
  • payout_created - Payout Created
  • rep_created - Rep Created
Available options:
customer_created,
customer_updated,
customer_address_created,
customer_address_updated,
customer_address_deleted,
customer_approved,
customer_unapproved,
order_created,
order_approved,
shipment_created,
order_terms_payment_created,
order_terms_payment_reversed,
order_terms_allowance_created,
order_terms_allowance_reversed,
order_refund_created,
payout_created,
rep_created

Response

201 - application/json
id
string<uuid>
required
read-only
destination_url
string<uri>
required
Minimum string length: 1
topic
enum<string>
required
  • customer_created - Customer Created
  • customer_updated - Customer Updated
  • customer_address_created - Customer Address Created
  • customer_address_updated - Customer Address Updated
  • customer_address_deleted - Customer Address Deleted
  • customer_approved - Customer Approved
  • customer_unapproved - Customer Unapproved
  • order_created - Order Created
  • order_approved - Order Approved
  • shipment_created - Shipment Created
  • order_terms_payment_created - Order Terms Payment Created
  • order_terms_payment_reversed - Order Terms Payment Reversed
  • order_terms_allowance_created - Order Terms Allowance Created
  • order_terms_allowance_reversed - Order Terms Allowance Reversed
  • order_refund_created - Order Refund Created
  • payout_created - Payout Created
  • rep_created - Rep Created
Available options:
customer_created,
customer_updated,
customer_address_created,
customer_address_updated,
customer_address_deleted,
customer_approved,
customer_unapproved,
order_created,
order_approved,
shipment_created,
order_terms_payment_created,
order_terms_payment_reversed,
order_terms_allowance_created,
order_terms_allowance_reversed,
order_refund_created,
payout_created,
rep_created