Create an Alert

post

https://api.zylo.com/v2/alerts

Required Permissions

applications:write

Rate Limit

limited

📘
Important Note
When creating an alert, refer to the Alerts documentation for guidance. This contains important information on configuring alert settings.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

application_id

string | null

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Unique identifier for the application this alert is associated with.

contract_id

string | null

[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-4[0-9A-Fa-f]{3}-[89ABab][0-9A-Fa-f]{3}-[0-9A-Fa-f]{12}

Unique identifier for the contract this alert is associated with.

memo

string | null

The alert memo. This is additional information included in the alert notification.

owner

string

required

^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+.[a-zA-Z]{2,}$

Email address of the Owner. The email must belong to a user in the Zylo system.

type

string

enum

required

Type of alert. There are three types of alerts; contract-renewal, renewal, and transaction.

Allowed:

Response

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Ok