Update webhook

PATCH

webhooks

{webhooks_uuid}

Update webhook

curl --request PATCH \
  --url https://sandbox.gateway.sezzle.com/v2/webhooks/{webhooks_uuid} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhooks-updated",
  "events": [
    "order.captured",
    "order.refunded"
  ]
}
'

import requests

url = "https://sandbox.gateway.sezzle.com/v2/webhooks/{webhooks_uuid}"

payload = {
    "url": "https://example.com/webhooks-updated",
    "events": ["order.captured", "order.refunded"]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://example.com/webhooks-updated',
    events: ['order.captured', 'order.refunded']
  })
};

fetch('https://sandbox.gateway.sezzle.com/v2/webhooks/{webhooks_uuid}', 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/{webhooks_uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://example.com/webhooks-updated',
    'events' => [
        'order.captured',
        'order.refunded'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.gateway.sezzle.com/v2/webhooks/{webhooks_uuid}"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/webhooks-updated\",\n  \"events\": [\n    \"order.captured\",\n    \"order.refunded\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://sandbox.gateway.sezzle.com/v2/webhooks/{webhooks_uuid}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/webhooks-updated\",\n  \"events\": [\n    \"order.captured\",\n    \"order.refunded\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.gateway.sezzle.com/v2/webhooks/{webhooks_uuid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/webhooks-updated\",\n  \"events\": [\n    \"order.captured\",\n    \"order.refunded\"\n  ]\n}"

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"
    }
  ]
}

[
  {
    "code": "bad_request",
    "message": "bad request"
  }
]

[
  {
    "code": "unauthorized",
    "message": "authorization not accepted"
  }
]

[
  {
    "code": "record_not_found",
    "message": "not found"
  }
]

[
  {
    "code": "invalid",
    "message": "Unprocessable entity"
  }
]

Use this endpoint to update an existing webhook configuration. You can modify both the webhook URL and the events subscribed to.

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

Notes

Both url and events fields are required in the request body
The webhook URL must be unique per merchant - you cannot update to a URL that is already in use by another webhook
If the webhook UUID is not found, a 404 error will be returned
Event subscriptions are replaced entirely - specify all events you want to receive, not just the changes

Authorizations

Authorization

string

header

required

The authentication token generated from providing API Keys to Sezzle Gateway

Path Parameters

webhooks_uuid

string

required

The webhook UUID to be updated

Body

application/json

url

string

required

The URL you are using to receive webhooks

events

enum<string>[]

required

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

Response

Successful Operation

uuid

string

The unique identifier for this response

links

object[]

Available API links prefilled with UUID with accompanying method

Hide child attributes

links.href

string

required

The fully qualified URL for the API endpoint

links.rel

enum<string>

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

links.method

enum<string>

The HTTP method to use when calling this API endpoint

Available options:

GET,

POST,

PATCH,

DELETE

Trigger a test webhookTrigger a test event to mimic a webhook event at a given URL.

⌘I

Update webhook

curl --request PATCH \
  --url https://sandbox.gateway.sezzle.com/v2/webhooks/{webhooks_uuid} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "url": "https://example.com/webhooks-updated",
  "events": [
    "order.captured",
    "order.refunded"
  ]
}
'

import requests

url = "https://sandbox.gateway.sezzle.com/v2/webhooks/{webhooks_uuid}"

payload = {
    "url": "https://example.com/webhooks-updated",
    "events": ["order.captured", "order.refunded"]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    url: 'https://example.com/webhooks-updated',
    events: ['order.captured', 'order.refunded']
  })
};

fetch('https://sandbox.gateway.sezzle.com/v2/webhooks/{webhooks_uuid}', 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/{webhooks_uuid}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'url' => 'https://example.com/webhooks-updated',
    'events' => [
        'order.captured',
        'order.refunded'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.gateway.sezzle.com/v2/webhooks/{webhooks_uuid}"

	payload := strings.NewReader("{\n  \"url\": \"https://example.com/webhooks-updated\",\n  \"events\": [\n    \"order.captured\",\n    \"order.refunded\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://sandbox.gateway.sezzle.com/v2/webhooks/{webhooks_uuid}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"url\": \"https://example.com/webhooks-updated\",\n  \"events\": [\n    \"order.captured\",\n    \"order.refunded\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.gateway.sezzle.com/v2/webhooks/{webhooks_uuid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"url\": \"https://example.com/webhooks-updated\",\n  \"events\": [\n    \"order.captured\",\n    \"order.refunded\"\n  ]\n}"

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"
    }
  ]
}

[
  {
    "code": "bad_request",
    "message": "bad request"
  }
]

[
  {
    "code": "unauthorized",
    "message": "authorization not accepted"
  }
]

[
  {
    "code": "record_not_found",
    "message": "not found"
  }
]

[
  {
    "code": "invalid",
    "message": "Unprocessable entity"
  }
]

API Reference

Tokenization

v1 (deprecated)

Update webhook

Valid Webhook Events

Notes

Authorizations

Path Parameters

Body

Response

​Valid Webhook Events

​Notes

Authorizations

Path Parameters

Body

Response

Valid Webhook Events

Notes