Webhooks

What are Webhooks?

Webhooks, also called a web callback or HTTP push API, are a way for apps to provide real-time information to other apps. They provide real-time updates on a particular event when it happens (for example, when you receive a new order in your Sellfy store) and send information that can be used by other apps or data processing. 

The first event we've added to Sellfy is “New Order”. This means - when you create a webhook inside your Sellfy store, every time a new order comes in (or an existing order is modified, for example, refunded), we send the Order data to the users' provided URL. So your Sellfy store orders are monitored and when a particular event happens (like a new order or a refund) – we trigger the Order data to be sent over an HTTP API POST request.

How do I set up a Webhook?

You can create your webhook in https://sellfy.com/user/settings/webhooks

Currently, we only support the so-called “New Order” event, which allows you to receive real-time data about each new order or change in an existing one.

To enable a webhook, you need to provide the Title and URL to your address where you will catch and work with this Order data.

Technically, we are creating HTTP POST request with JSON data to user provided URL in webhooks.

Sample JSON data

{
  "id": "dmnVQFUm",
  "status": "COMPLETED",
  "customer": {
    "ip": "85.169.155.202",
    "country": "US",
    "payment_type": "",
    "email": "[email protected]"
  },
  "currency": "USD",
  "tax": {
    "amount": 105,
    "percents": 21
  },
  "discount": {
    "amount": 200
  },
  "amount": 605,
  "products": [
	{
    		"key": "QFUm",
    		"amount": 505,
   	 	"quantity": 1
	},
	{
    		"key": "dmnV",
    		"amount": 100,
    		"quantity": 1
	}
  ],
  "date": "2018-01-17T12:28:00+00:00"
}

JSON fields details

New order fields:

Key Type Description
ID string Unique transaction ID
  • Status
 string Status of a particular order. It can be:
  • COMPLETED
  • COMPLETED_FUNDS_HELD
  • PARTIALLY_REFUNDED
  • CANCELED_REVERSAL
  • DENIED
  • FAILED
  • REFUNDED
  • REVERSED
Customer object this object contains information about the buyer. The related fields are:
  • Country
 string  in ISO 3166-1 alpha-2 format - buyer country
  • Payment Type
 string  not implemented yet
  • Email
 string  buyer email address
  • IP
 string  buyer IP address
Discount object  this object contains only the amount of discount that is applied to all purchases
  • Amount
 integer  in cents - total amount of discount on purchase.
Tax object this object contains information about tax amount that was applied to this purchase
  • Amount
 integer in cents - total amount of tax on purchase.
  • Percent
 integer tax percent that was applied to purchase.      
Currency string in ISO 4217 format - currency name
Amount integer in cents - total amount charged from the buyer.
Products
list this list contains unique keys of products that were in the purchase.
  • Key
 string Unique product key
  • Amount
 integer in cents - total amount charged for single item in the cart
  • Quantity
 integer Number of items sold (for digital products defaults to 1)
Date string in ISO 8601 format - date when new order was made

Still need help? Contact Us Contact Us