DEdebitura
Webhooks

Update an existing webhook subscription.

Changed on

Partially updates an existing webhook subscription using HTTP PATCH.

Supported Updates:

  • Change the webhook URL
  • Enable or disable the subscription
  • Regenerate the secret key

Note: Event types cannot be changed after creation. To update event types, delete and recreate the subscription.

patch/webhooks/{id}

Request

  • Base URL
    https://customer-api.debitura.com
  • URL
    https://customer-api.debitura.com/webhooks/{id}
  • Auth
    • API key in header XApiKey
    • or HTTP bearer

Path parameters

idstring uuid required

Request body

urlstring uri nullable
eventsstring[] nullable
isActiveboolean nullable
regenerateSecretboolean
isTestModeboolean nullable

Response

Webhook updated successfully

idstring uuid
urlstring nullable
eventsstring[] nullable
isActiveboolean
createdUtcstring date-time
updatedUtcstring date-time
disabledReasonstring nullable
secretstring nullable
isTestModeboolean

Changes

  • 6760dced1c2dRevision changes
    • breaking

      the request property's maxLength was decreased to 800 (media type: application/json-patch+json)

    • breaking

      the request property's maxLength was decreased to 800 (media type: application/json)

    • breaking

      the request property's maxLength was decreased to 800 (media type: text/json)

    • breaking

      the request property's maxLength was decreased to 800 (media type: application/*+json)