Changelog
Back to All

Webhooks API - Added subscription name and description parameters with validation

April 8th, 2025

Description

Added optional name and description parameters to the POST /webhooks-api/v201907/subscriptions endpoint request and response.
Both fields are validated:

  • name should have maximum length of 100 characters, and contain only alphanumeric characters and spaces,
  • description should have maximum length of 500 characters, and cannot contain ;\<>{} characters.

If present, name and description parameters will be added to responses for endpoints:

  • GET /webhooks-api/v201907/subscriptions
  • GET /webhooks-api/v201907/subscriptions/{subscriptionId}

Impact

This enhancement is backward-compatible and does not require any changes to existing client implementations.

References