Webhooks
List webhooks
Get a list of webhooks you are subscribed to
GET
/
v2
/
webhooks
List webhooks
curl --request GET \
--url https://sandbox.gateway.sezzle.com/v2/webhooks \
--header 'Authorization: <api-key>'import requests
url = "https://sandbox.gateway.sezzle.com/v2/webhooks"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://sandbox.gateway.sezzle.com/v2/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.gateway.sezzle.com/v2/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.gateway.sezzle.com/v2/webhooks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.gateway.sezzle.com/v2/webhooks")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.gateway.sezzle.com/v2/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"uuid": "747cf28a-bb5c-46a8-a288-d9b006fd6113",
"links": [
{
"href": "https://sandbox.gateway.sezzle.com/v2/webhooks",
"rel": "create",
"method": "POST"
},
{
"href": "https://sandbox.gateway.sezzle.com/v2/webhooks",
"rel": "list",
"method": "GET"
},
{
"href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
"rel": "self",
"method": "GET"
},
{
"href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
"rel": "self",
"method": "PATCH"
},
{
"href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
"rel": "self",
"method": "DELETE"
}
],
"url": "https://example.com/webhooks",
"events": [
"customer.tokenized"
]
}
][
{
"code": "bad_request",
"message": "bad request"
}
][
{
"code": "unauthorized",
"message": "authorization not accepted"
}
][
{
"code": "record_not_found",
"message": "not found"
}
][
{
"code": "invalid",
"message": "Unprocessable entity"
}
]Valid Webhook Events
We accept the following Webhook events| Event | Trigger |
|---|---|
customer.tokenized | A customer is tokenized |
order.authorized | An order is authorized by Sezzle |
order.captured | An order is captured by Sezzle |
order.refunded | An order is refunded by Sezzle |
dispute.merchant_input_requested | A dispute is filed by a shopper and merchant input is required |
dispute.deadline_approaching | A dispute is moved to final notice by Sezzle |
dispute.closed.customer_win | The shopper wins the dispute and the order is refunded |
dispute.closed.merchant_win | The merchant wins the dispute and it is resolved in their favor |
dispute.closed.neutral | No clear winner is determined and the dispute is resolved neutrally |
Authorizations
The authentication token generated from providing API Keys to Sezzle Gateway
Response
Successful Operation
The URL you are using to receive webhooks
An array of webhook events you wish to subscribe to
Available options:
customer.tokenized, order.authorized, order.captured, order.refunded, dispute.merchant_input_requested, dispute.deadline_approaching, dispute.closed.customer_win, dispute.closed.merchant_win, dispute.closed.neutral The unique identifier for this response
Available API links prefilled with UUID with accompanying method
Hide child attributes
Hide child attributes
The fully qualified URL for the API endpoint
The relationship type indicating the purpose of this link (e.g., 'self' for the current resource, 'create' for creating a new resource, 'list' for listing resources)
Available options:
self, capture, checkout, create, customer, list, order, preapprove, refund, release, session The HTTP method to use when calling this API endpoint
Available options:
GET, POST, PATCH, DELETE Example:
[
{
"uuid": "747cf28a-bb5c-46a8-a288-d9b006fd6113",
"links": [
{
"href": "https://sandbox.gateway.sezzle.com/v2/webhooks",
"rel": "create",
"method": "POST"
},
{
"href": "https://sandbox.gateway.sezzle.com/v2/webhooks",
"rel": "list",
"method": "GET"
},
{
"href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
"rel": "self",
"method": "GET"
},
{
"href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
"rel": "self",
"method": "PATCH"
},
{
"href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
"rel": "self",
"method": "DELETE"
}
],
"url": "https://example.com/webhooks",
"events": ["customer.tokenized"]
}
]
⌘I
List webhooks
curl --request GET \
--url https://sandbox.gateway.sezzle.com/v2/webhooks \
--header 'Authorization: <api-key>'import requests
url = "https://sandbox.gateway.sezzle.com/v2/webhooks"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://sandbox.gateway.sezzle.com/v2/webhooks', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://sandbox.gateway.sezzle.com/v2/webhooks",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://sandbox.gateway.sezzle.com/v2/webhooks"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://sandbox.gateway.sezzle.com/v2/webhooks")
.header("Authorization", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://sandbox.gateway.sezzle.com/v2/webhooks")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'
response = http.request(request)
puts response.read_body[
{
"uuid": "747cf28a-bb5c-46a8-a288-d9b006fd6113",
"links": [
{
"href": "https://sandbox.gateway.sezzle.com/v2/webhooks",
"rel": "create",
"method": "POST"
},
{
"href": "https://sandbox.gateway.sezzle.com/v2/webhooks",
"rel": "list",
"method": "GET"
},
{
"href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
"rel": "self",
"method": "GET"
},
{
"href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
"rel": "self",
"method": "PATCH"
},
{
"href": "https://sandbox.gateway.sezzle.com/v2/webhooks/747cf28a-bb5c-46a8-a288-d9b006fd6113",
"rel": "self",
"method": "DELETE"
}
],
"url": "https://example.com/webhooks",
"events": [
"customer.tokenized"
]
}
][
{
"code": "bad_request",
"message": "bad request"
}
][
{
"code": "unauthorized",
"message": "authorization not accepted"
}
][
{
"code": "record_not_found",
"message": "not found"
}
][
{
"code": "invalid",
"message": "Unprocessable entity"
}
]