DEdebitura
Webhooks

Update an existing webhook subscription.

Changed on

Updates webhook URL, events, or active status. Set RegenerateSecret=true to rotate signing secret (returned in response). Use IsActive=true to re-enable auto-disabled webhooks after fixing delivery issues. Secret only included if RegenerateSecret=true.

put/webhooks/{id}

Request

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

Path parameters

idstring uuid required

The unique identifier of the webhook subscription to update.

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

  • a7cf0ff022b6Revision 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)