Webhook Events

Site Status Update

This event is triggered whenever the status of a site changes.

Sample Payload -

{
   "event":"Site Status Update",
   "data":{
      "doctype":"Site",
      "name":"test1234.frappe.cloud",
      "owner":"tanmoy@frappe.io",
      "creation":"2024-09-24 12:35:06.878475",
      "modified":"2024-09-24 12:38:21.804601",
      "modified_by":"Administrator",
      "docstatus":0,
      "idx":0,
      "ip":"None",
      "status":"Active",
      "group":"bench-6930",
      "notify_email":"tanmoy@frappe.io",
      "team":"51878bd62b",
      "plan":"USD 10",
      "setup_wizard_complete":0,
      "archive_failed":0,
      "cluster":{
         "title":"Bangalore, India",
         "image":"/files/india.svg"
      },
      "bench":"bench-6930-000125-f1-blr",
      "is_database_access_enabled":0,
      "trial_end_date":"None",
      "tags":[

      ],
      "server":"f1-blr.frappe.cloud",
      "host_name":"test1234.frappe.cloud",
      "skip_auto_updates":0,
      "additional_system_user_created":0,
      "group_title":"Version 15",
      "version":"Version 15",
      "group_team":"team@erpnext.com",
      "group_public":1,
      "latest_frappe_version":"Version 15",
      "owner_email":"tanmoy@frappe.io",
      "current_usage":{
         "cpu":4e-05,
         "storage":0,
         "database":0,
         "hours_until_cpu_usage_resets":11.36
      },
      "current_plan":{
         "doctype":"Site Plan",
         "name":"USD 10",
         "owner":"rutwik@frappe.io",
         "creation":"2024-02-21 19:12:34.020200",
         "modified":"2024-02-21 19:12:34.020200",
         "modified_by":"rutwik@frappe.io",
         "docstatus":0,
         "idx":6372,
         "plan_title":"$10",
         "document_type":"Site",
         "document_name":"None",
         "price_inr":820.0,
         "price_usd":10.0,
         "period":"None",
         "cpu_time_per_day":1.0,
         "max_database_usage":500,
         "max_storage_usage":5120,
         "database_access":0,
         "support_included":0,
         "private_benches":0,
         "monitor_access":0,
         "price_per_day_inr":27.33,
         "price_per_day_usd":0.33
      },
      "last_updated":"None",
      "has_scheduled_updates":false,
      "update_information":{
         "update_available":false
      },
      "outbound_ip":"165.232.186.49",
      "server_team":"team@erpnext.com",
      "server_title":"f1-blr.frappe.cloud",
      "inbound_ip":"68.183.89.27",
      "is_dedicated_server":false
   }
}

Site Plan Change

This event is triggered whenever a site is upgraded or downgraded to a different site plan.

Sample Payload -

{
   "event":"Site Plan Change",
   "data":{
      "doctype":"Site Plan Change",
      "name":"368704046d",
      "owner":"tanmoy@frappe.io",
      "creation":"2024-09-24 11:29:41.596739",
      "modified":"2024-09-24 11:29:41.596739",
      "modified_by":"tanmoy@frappe.io",
      "docstatus":0,
      "idx":0,
      "from_plan":"USD 10",
      "to_plan":"USD 25",
      "type":"Upgrade",
      "site":"test465.frappe.cloud",
      "timestamp":"2024-09-24 11:29:41.596639"
   }
}

If you have a requirement for other events, please raise a feature request on github.