February 16, 2026
13 days ago
Added a new Alerts resource for managing notification alerts about contract renewals and application transactions.
Added
Alerts
The Alerts API provides endpoints to create and manage notification alerts that notify users about important events:
Get Alerts
- An endpoint to retrieve all alerts configured for your company.
Get Alert by ID
- An endpoint to retrieve a specific alert by its unique identifier.
Create Alert
- An endpoint to create new alerts for contract renewals or application transactions.
- Supports three alert types:
- Renewal alerts - Notify when an application's contract is approaching renewal (7-240 days in advance)
- Transaction alerts - Notify when application transactions exceed a specified threshold
- Contract renewal alerts - Notify when a contract is approaching renewal
- Alerts require at least one email recipient and an owner.
- Alert delivery method is automatically set to email.
Update Alert
- An endpoint to modify alert properties like memo, owner, and notification settings.
- Note: Alert type and associated application/contract cannot be changed after creation.
Delete Alert
- An endpoint to delete an alert by its unique identifier.
Alert Fields
The following fields are available in the Alerts resource:
id- Unique identifier for the alerttype- Alert type (renewal, transaction, or contract-renewal)application_id- The application this alert is associated with (for renewal and transaction alerts)contract_id- The contract this alert is associated with (for contract-renewal alerts)owner- Email address of the alert ownermethod- Alert delivery method (currently email only)settings- Configuration object containing recipients and alert-specific settings (notification periods, thresholds, etc.)memo- Optional note about the alertlast_processed_date- Date and time the alert was last processedzylo_created_at- Date and time the alert was createdzylo_modified_at- Date and time the alert was last modified
Updatable Fields
The following fields can be modified after alert creation:
owner- Change the alert ownersettings- Update recipients or alert-specific configurationmemo- Update the alert note
