Skip to main content
PATCH
/
v2
/
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"
  ]
}
'
{
  "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"
    }
  ]
}
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
EventTrigger
customer.tokenizedA customer is tokenized
order.authorizedAn order is authorized by Sezzle
order.capturedAn order is captured by Sezzle
order.refundedAn order is refunded by Sezzle
dispute.merchant_input_requestedA dispute is filed by a shopper and merchant input is required
dispute.deadline_approachingA dispute is moved to final notice by Sezzle
dispute.closed.customer_winThe shopper wins the dispute and the order is refunded
dispute.closed.merchant_winThe merchant wins the dispute and it is resolved in their favor
dispute.closed.neutralNo 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