Frappe Cloud Webhook Events

Frappe Cloud can send webhook events whenever important actions occur on your sites or benches. These events allow your applications to automate workflows, monitor deployments, and respond to infrastructure changes in real time.

Site Status Update

This event is triggered whenever the status of a site changes, such as when a site becomes Active, Suspended, or undergoes another status transition. The webhook payload contains detailed information about the site, including its name, plan, bench, server, status, and other metadata.

Sample Payload

{
  "doctype": "Site",
  "name": "ytest.tanmoy.fc.frappe.dev",
  "status": "Active",
  "plan": "ERPNext Trial",
  "bench": "bench-0008-000005-f1",
  "server": "f1.tanmoy.fc.frappe.dev",
  "host_name": "ytest.tanmoy.fc.frappe.dev"
}

Site Plan Change

This event is triggered whenever a site is upgraded or downgraded to a different hosting plan. It provides details about the previous plan, the new plan, the type of change, and the timestamp.

Sample Payload

{
  "event": "Site Plan Change",
  "data": {
    "from_plan": "USD 10",
    "to_plan": "USD 25",
    "type": "Upgrade",
    "site": "test465.frappe.cloud",
    "timestamp": "2024-09-24 11:29:41"
  }
}

Bench Deploy Status Update

This event is triggered whenever a new bench deployment is created within a Bench Group. It reports every stage of the deployment process, making it useful for deployment monitoring and automation.

Sample Payload

{
  "event": "Bench Deploy Status Update",
  "data": {
    "name": "deploy-0019-000059",
    "status": "Success",
    "group": "bench-0019",
    "build_duration": "0:00:41.794537"
  }
}

Bench Status Update

This event is triggered whenever the status of a bench changes because of actions such as installation, updates, activation, or archival.

Sample Payload

{
  "event": "Bench Status Update",
  "data": {
    "name": "bench-0019-000059-f2-london",
    "status": "Pending",
    "group": "bench-0019",
    "cluster": "London"
  }
}