Webhooks

Update webhook status

Changed on

Updates the status of a webhook (ACTIVE/DISABLED). This operation is idempotent - if the status is already the requested value, no changes are made.

patch/api/webhooks/{webhookId}/status

Request

Path parameters

webhookIdstring required

Webhook ID

Request body

status'DISABLED' | 'ACTIVE' required

Webhook status - use to activate/deactivate

Response

Webhook status updated successfully

categoriesstring[] required

Event categories this webhook is subscribed to

createdAtstring date-time required

When the webhook was created

idstring required

Unique webhook identifier

publicKeystring required

ECDSA public key in PEM format for signature verification

status'DISABLED' | 'ACTIVE' required

Webhook status

updatedAtstring date-time required

When the webhook was last updated

urlstring required

Webhook endpoint URL

versionnumber required

Webhook version for tracking changes

Changes

    • warning

      added the new RFI enum value to the / response property for the response status

    • warning

      added the new SignedAgreementRequiredException enum value to the response property for the response status

    • info

      added the non-success response with the status