NOTAM Watcher API
Python SDK Example
from notamify_sdk import NotamifyClient
client = NotamifyClient(token="YOUR_API_KEY")
# List all listeners
listeners = client.list_listeners()
for listener in listeners:
print(f"{listener.name} ({listener.id}) — active: {listener.active}")
# Create a listener with filters
listener = client.create_listener(
name="JFK Runway Monitor",
webhook_url="https://your-server.com/webhooks/notamify",
filters={
"notam_icao": ["KJFK"],
"category": ["RUNWAY"],
},
lifecycle_enabled=True,
mode="prod",
)
print(f"Created listener: {listener.id}")
# Update a listener
updated = client.update_listener(
listener.id,
filters={
"notam_icao": ["KJFK", "KEWR"],
"category": ["AERODROME", "OBSTACLES"],
},
)
# Delete a listener
client.delete_listener(listener.id)
# Sandbox testing — trigger a test delivery
result = client.send_sandbox_message(listener.id)
print(f"Sandbox delivery: {result}")Optional human-readable name for the listener (max 100 characters).
Destination HTTPS/HTTP endpoint for notifications. Must be a public URL, not localhost or private network ranges. Each owner can have at most one active trycloudflare.com webhook listener. Required when emails are omitted or empty.
Optional email recipients for notification delivery. Required when webhook_url is omitted.
Whether the listener is active. Defaults to true if not provided. Set to false to temporarily disable notifications without deleting the listener.
trueListener delivery mode. 'prod' receives live matching events. 'sandbox' is for manual test sends only.
prodPossible values: Listener created
Team context when the listener was created or updated by a team-authenticated principal. Team-level alert email profiles apply only when this value is present.
Optional human-readable name for the listener (max 100 characters).
Destination HTTPS/HTTP endpoint for notifications. Must be a public URL, not localhost or private network ranges. Each owner can have at most one active trycloudflare.com webhook listener.
Optional email recipients for notification delivery.
Whether the listener is active and will receive notifications.
Listener delivery mode. 'prod' receives live matching events. 'sandbox' is for manual test sends only.
Webhook signing secret (returned once on creation/rotation).
Bad Request
Unauthorized
Forbidden
Internal Server Error
Listener ID
Optional human-readable name for the listener (max 100 characters).
Destination HTTPS/HTTP endpoint for notifications. Must be a public URL, not localhost or private network ranges. Each owner can have at most one active trycloudflare.com webhook listener. Required when emails are omitted or empty.
Optional email recipients for notification delivery. Required when webhook_url is omitted.
Whether the listener is active. Defaults to true if not provided. Set to false to temporarily disable notifications without deleting the listener.
trueListener delivery mode. 'prod' receives live matching events. 'sandbox' is for manual test sends only.
prodPossible values: Listener updated
Team context when the listener was created or updated by a team-authenticated principal. Team-level alert email profiles apply only when this value is present.
Optional human-readable name for the listener (max 100 characters).
Destination HTTPS/HTTP endpoint for notifications. Must be a public URL, not localhost or private network ranges. Each owner can have at most one active trycloudflare.com webhook listener.
Optional email recipients for notification delivery.
Whether the listener is active and will receive notifications.
Listener delivery mode. 'prod' receives live matching events. 'sandbox' is for manual test sends only.
Bad Request
Unauthorized
Forbidden
Not Found
Internal Server Error
Listener ID
Deleted
No content
Unauthorized
Forbidden
Not Found
Internal Server Error
No content
Last updated