Webhooks
In this article:
What are Webhooks?
Webhooks, also referred to as web callback or HTTP push API, is an integration tool that helps to keep track of events that are happening in your store. The integrated app provides real-time information and updates about particular events connected to your store.
How do I set up Webhooks?
To enable Webhooks in your Sellfy store, you first need to create your own Webhook
Once you've created your Webhook, you can enable the integration. To do so, you'll need to provide the Title and URL of the address that you'll use to collect and work with this event data.
Technically, Sellfy creates HTTP POST requests with JSON data to the user-provided URL in the webhooks.
Available events
| Type | Description |
|---|---|
| New order | Occurs whenever an order payment is completed or payment status is changed. For subscriptions, this event will reoccur with each payment. |
| Email subscribe | Occurs whenever a customer is subscribed to your newsletter list |
| Email unsubscribe | Occurs whenever a customer is unsubscribed from all emails |
New Order event
Sample JSON data
{
"id": "dmnVQFUm",
"status": "COMPLETED",
"currency": "USD",
"amount": 449,
"discount": {
"amount": 499
},
"tax": {
"amount": 0,
"percents": 0
},
"customer": {
"country": "US",
"payment_type": "card",
"email": "[email protected]",
"ip": "85.169.155.202",
"consent_to_newsletters": true
},
"products": [
{
"id": "61d2ef5352ca3cdc80662cb1",
"key": "uQsm",
"name": "Icon set",
"amount": 299,
"discount": {
"type": "coupon",
"code": "25OFF",
"amount": 25,
"amount_type": "percentage",
"amount_applied": 25,
"currency": "USD"
},
"quantity": 1
},
{
"id": "61d2ef5352ca3cdc80662cb4",
"key": "QFUm",
"type": "sale",
"name": "Holiday cards",
"amount": 0,
"discount": {
"type": "sale",
"amount": 500,
"amount_type": "fixed",
"amount_applied": 399,
"currency": "USD"
},
"quantity": 1
},
{
"id": "61d2ef5352ca3cdc80662cb7",
"key": "dmnV",
"name": "Awesome serif-font",
"amount": 150,
"discount": {},
"quantity": 1
}
],
"date": "2022-01-12T11:57:59+00:00"
}
Field description
| Key | Description | ||
|---|---|---|---|
| id | Unique transaction ID | ||
| status | Payment status. One of the following:
|
||
| customer | Object that contains information about the customer | ||
| customer. ip | IP address | ||
| customer. country | ISO 3166-1 alpha-2 format | ||
| customer. payment_type | Payment gateway used to perform this transaction. One of the following:
|
||
| customer. email | Email address | ||
| currency | ISO 4217 format | ||
| tax | Object that contains information about the tax (if applied) | ||
| tax. amount | In cents - total amount of tax applied to purchase | ||
| tax. percents | Tax percents (0-100) that was applied to purchase | ||
| discount | Object that contains information about the discount (if applied) | ||
| discount. amount | In cents - total amount of discount applied to purchase | ||
| amount | In cents - total amount charged from the buyer | ||
| date | ISO 8601 format | ||
| products | Array of products purchased | ||
| products. id | Unique product ID | ||
| products. key | Unique product key (deprecated, use Product ID instead) | ||
| products. amount | In cents - total amount charged for current product | ||
| products. quantity | Number of items sold | products. discount | Information about the discount that was applied (if any) |
Email subscribe / unsubscribe
Sample JSON data
{
"customer": {
"email": "[email protected]"
},
"date": "2018-01-17T12:28:00+00:00"
}
Field description
| Key | Description |
|---|---|
| customer | Object that contains information about the customer |
| customer. email | Email address |
| date | ISO 8601 format |