Passer au contenu principal
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"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.sezzle.com/llms.txt

Use this file to discover all available pages before exploring further.

Utilisez ce endpoint pour mettre à jour une configuration de webhook existante. Vous pouvez modifier à la fois l’URL du webhook et les événements auxquels vous êtes abonné.

​
Événements Webhook valides

Nous acceptons les événements Webhook suivants
ÉvénementDéclencheur
customer.tokenizedUn client est tokenisé
order.authorizedUne commande est autorisée par Sezzle
order.capturedUne commande est capturée par Sezzle
order.refundedUne commande est remboursée par Sezzle
dispute.merchant_input_requestedUn litige est déposé par un acheteur et la contribution du marchand est requise
dispute.deadline_approachingUn litige est passé en avis final par Sezzle
dispute.closed.customer_winL’acheteur remporte le litige et la commande est remboursée
dispute.closed.merchant_winLe marchand remporte le litige et celui-ci est résolu en sa faveur
dispute.closed.neutralAucun gagnant clair n’est déterminé et le litige est résolu de manière neutre

​
Remarques

  • Les deux champs url et events sont requis dans le corps de la requête
  • L’URL du webhook doit être unique par marchand - vous ne pouvez pas mettre à jour vers une URL déjà utilisée par un autre webhook
  • Si l’UUID du webhook n’est pas trouvé, une erreur 404 sera renvoyée
  • Les abonnements aux événements sont entièrement remplacés - spécifiez tous les événements que vous souhaitez recevoir, pas seulement les modifications

Autorisations

​
Authorization
string
header
requis

The authentication token generated from providing API Keys to Sezzle Gateway

Paramètres de chemin

​
webhooks_uuid
string
requis

The webhook UUID to be updated

Corps

application/json
​
url
string
requis

The URL you are using to receive webhooks

​
events
enum<string>[]
requis

An array of webhook events you wish to subscribe to

Options disponibles:
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

Réponse

Successful Operation

​
uuid
string

The unique identifier for this response

​
links
object[]

Available API links prefilled with UUID with accompanying method