Webhook events

Download schema

Requests sent to your webhook endpoints when something happens. Each page shows the headers and body of the request, and the response your endpoint should give.

server.created

POSTyour webhook endpointWebhook

A server was added and waits for its agent.

server.created › Headers

webhook-id

string · required

The event's id, the same on every attempt.

webhook-timestamp

string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature

string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

server.created › Request Body

ServerCreatedEvent

id

string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: event_01m6v3f5aydrktmzrbpz1pqh7e

type

string · enum · required

A server was added and waits for its agent.

Enum values:

server.created

timestamp

string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version

string · required

The version of the payload format.

Example: v1

object · required

server.created › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

Example Request Body

{
  "id": "event_01m6v3f5aydrktmzrbpz1pqh7e",
  "type": "server.created",
  "timestamp": "2024-08-25T15:00:00Z",
  "api_version": "v1",
  "data": {
    "object": {
      "id": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "name": "web-01",
      "hostname": "web-01.example.com",
      "owner_team": {
        "slug": "acme",
        "name": "Acme Inc"
      },
      "access": "owner",
      "tags": [
        {
          "id": "tag_01j8q8zk2f4m6n7p9r1s3t5v7x",
          "name": "production",
          "color": "zinc"
        }
      ],
      "metadata": {
        "key": "string"
      },
      "status": "pending",
      "agent_version": "1.0.0",
      "agent": {
        "version": "1.0.0",
        "update_available": true,
        "auto_updates": {
          "enabled": true,
          "is_default": true
        },
        "capability": {
          "available": true,
          "reason": "installed from a tarball"
        },
        "reboot": {
          "available": true,
          "reason": "running in a Docker container"
        },
        "upgrade_packages": {
          "available": true,
          "reason": "the root helper does not answer"
        },
        "disabled_actions": [
          "reboot"
        ]
      },
      "last_contact_at": "last_contact_at",
      "fqdn": "web-01.example.com",
      "os_family": "debian",
      "os_id": "ubuntu",
      "os_name": "Ubuntu",
      "os_version": "24.04.1",
      "os_codename": "noble",
      "kernel_release": "6.8.0-45-generic",
      "arch": "amd64",
      "virtualization": "guest/kvm",
      "boot_time": "boot_time",
      "cpu_model": "AMD EPYC 7763 64-Core Processor",
      "cpu_cores": 4,
      "cpu_threads": 8,
      "memory_bytes": 17179869184,
      "swap_bytes": 0,
      "disk_bytes": 0,
      "storage_health": "healthy",
      "storage_unhealthy_since": "storage_unhealthy_since",
      "public_ipv4": "203.0.113.10",
      "public_ipv6": "2001:db8::10",
      "observed_ip": "198.51.100.7",
      "nameservers": [
        "string"
      ],
      "addresses": [
        {
          "interface": "eth0",
          "address": "203.0.113.10",
          "prefix": 24,
          "family": 4,
          "scope": "public"
        }
      ],
      "is_os_eol": true,
      "os_eol_at": "os_eol_at",
      "pending_updates_count": 12,
      "security_updates_count": 3,
      "reboot_required": true,
      "updates_checked_at": "updates_checked_at",
      "package_metadata_refresh": {
        "enabled": true,
        "interval": 21600,
        "is_default": true
      },
      "software": [
        {
          "product": "php",
          "version": "7.4.33",
          "package_version": "7.4.33-1+ubuntu16.04.1+deb.sury.org+1",
          "manager": "dpkg",
          "major": 7,
          "minor": 4,
          "patch": 33,
          "package": "php7.4-fpm",
          "source": "package",
          "is_eol": true,
          "eol_at": "eol_at"
        }
      ],
      "provider": "hetzner",
      "city": "Falkenstein",
      "country": "DE",
      "continent": "EU",
      "location_source": "agent",
      "cloud_region": "fsn1",
      "cloud_zone": "fsn1-dc14",
      "instance_type": "m6i.large",
      "asn": 24940,
      "asn_org": "Hetzner Online GmbH",
      "location_override": {
        "provider": "hetzner",
        "city": "Falkenstein",
        "country": "DE",
        "continent": "EU"
      },
      "vhosts_count": 12,
      "certificates_count": 4,
      "certificate_issues_count": 1,
      "repositories": {
        "count": 8,
        "third_party_count": 3,
        "issues_count": 1,
        "orphaned_packages_count": 2,
        "not_covered_packages_count": 4,
        "vendors": [
          {
            "slug": "slug",
            "label": "label",
            "kind": "distro",
            "repositories": 0,
            "issues": [
              "insecure_trusted"
            ]
          }
        ]
      },
      "vulnerabilities": {
        "release": "debian:12",
        "critical": 2,
        "high": 5,
        "medium": 12,
        "low": 20,
        "negligible": 30,
        "unknown": 1,
        "total": 70,
        "fixable": 9,
        "reboot": 1,
        "subscription": 3,
        "released": 0,
        "unfixed": 57,
        "checked_at": "checked_at"
      },
      "enrollment": {
        "token": "scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "install_command": "curl -fsSL https://pkg.server.chief.app/install.sh | sudo bash && sudo serverchief setup scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "expires_at": "expires_at"
      },
      "created_at": "created_at",
      "updated_at": "updated_at"
    }
  }
}

json

server.enrolled

POSTyour webhook endpointWebhook

A server's agent enrolled for the first time.

server.enrolled › Headers

webhook-id

string · required

The event's id, the same on every attempt.

webhook-timestamp

string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature

string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

server.enrolled › Request Body

ServerEnrolledEvent

id

string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: event_01m6v3f5aydrktmzrbpz1pqh7e

type

string · enum · required

A server's agent enrolled for the first time.

Enum values:

server.enrolled

timestamp

string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version

string · required

The version of the payload format.

Example: v1

object · required

server.enrolled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

Example Request Body

{
  "id": "event_01m6v3f5aydrktmzrbpz1pqh7e",
  "type": "server.enrolled",
  "timestamp": "2024-08-25T15:00:00Z",
  "api_version": "v1",
  "data": {
    "object": {
      "id": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "name": "web-01",
      "hostname": "web-01.example.com",
      "owner_team": {
        "slug": "acme",
        "name": "Acme Inc"
      },
      "access": "owner",
      "tags": [
        {
          "id": "tag_01j8q8zk2f4m6n7p9r1s3t5v7x",
          "name": "production",
          "color": "zinc"
        }
      ],
      "metadata": {
        "key": "string"
      },
      "status": "pending",
      "agent_version": "1.0.0",
      "agent": {
        "version": "1.0.0",
        "update_available": true,
        "auto_updates": {
          "enabled": true,
          "is_default": true
        },
        "capability": {
          "available": true,
          "reason": "installed from a tarball"
        },
        "reboot": {
          "available": true,
          "reason": "running in a Docker container"
        },
        "upgrade_packages": {
          "available": true,
          "reason": "the root helper does not answer"
        },
        "disabled_actions": [
          "reboot"
        ]
      },
      "last_contact_at": "last_contact_at",
      "fqdn": "web-01.example.com",
      "os_family": "debian",
      "os_id": "ubuntu",
      "os_name": "Ubuntu",
      "os_version": "24.04.1",
      "os_codename": "noble",
      "kernel_release": "6.8.0-45-generic",
      "arch": "amd64",
      "virtualization": "guest/kvm",
      "boot_time": "boot_time",
      "cpu_model": "AMD EPYC 7763 64-Core Processor",
      "cpu_cores": 4,
      "cpu_threads": 8,
      "memory_bytes": 17179869184,
      "swap_bytes": 0,
      "disk_bytes": 0,
      "storage_health": "healthy",
      "storage_unhealthy_since": "storage_unhealthy_since",
      "public_ipv4": "203.0.113.10",
      "public_ipv6": "2001:db8::10",
      "observed_ip": "198.51.100.7",
      "nameservers": [
        "string"
      ],
      "addresses": [
        {
          "interface": "eth0",
          "address": "203.0.113.10",
          "prefix": 24,
          "family": 4,
          "scope": "public"
        }
      ],
      "is_os_eol": true,
      "os_eol_at": "os_eol_at",
      "pending_updates_count": 12,
      "security_updates_count": 3,
      "reboot_required": true,
      "updates_checked_at": "updates_checked_at",
      "package_metadata_refresh": {
        "enabled": true,
        "interval": 21600,
        "is_default": true
      },
      "software": [
        {
          "product": "php",
          "version": "7.4.33",
          "package_version": "7.4.33-1+ubuntu16.04.1+deb.sury.org+1",
          "manager": "dpkg",
          "major": 7,
          "minor": 4,
          "patch": 33,
          "package": "php7.4-fpm",
          "source": "package",
          "is_eol": true,
          "eol_at": "eol_at"
        }
      ],
      "provider": "hetzner",
      "city": "Falkenstein",
      "country": "DE",
      "continent": "EU",
      "location_source": "agent",
      "cloud_region": "fsn1",
      "cloud_zone": "fsn1-dc14",
      "instance_type": "m6i.large",
      "asn": 24940,
      "asn_org": "Hetzner Online GmbH",
      "location_override": {
        "provider": "hetzner",
        "city": "Falkenstein",
        "country": "DE",
        "continent": "EU"
      },
      "vhosts_count": 12,
      "certificates_count": 4,
      "certificate_issues_count": 1,
      "repositories": {
        "count": 8,
        "third_party_count": 3,
        "issues_count": 1,
        "orphaned_packages_count": 2,
        "not_covered_packages_count": 4,
        "vendors": [
          {
            "slug": "slug",
            "label": "label",
            "kind": "distro",
            "repositories": 0,
            "issues": [
              "insecure_trusted"
            ]
          }
        ]
      },
      "vulnerabilities": {
        "release": "debian:12",
        "critical": 2,
        "high": 5,
        "medium": 12,
        "low": 20,
        "negligible": 30,
        "unknown": 1,
        "total": 70,
        "fixable": 9,
        "reboot": 1,
        "subscription": 3,
        "released": 0,
        "unfixed": 57,
        "checked_at": "checked_at"
      },
      "enrollment": {
        "token": "scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "install_command": "curl -fsSL https://pkg.server.chief.app/install.sh | sudo bash && sudo serverchief setup scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "expires_at": "expires_at"
      },
      "created_at": "created_at",
      "updated_at": "updated_at"
    }
  }
}

json

server.updated

POSTyour webhook endpointWebhook

A server's name, metadata, location or settings changed.

server.updated › Headers

webhook-id

string · required

The event's id, the same on every attempt.

webhook-timestamp

string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature

string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

server.updated › Request Body

ServerUpdatedEvent

id

string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: event_01m6v3f5aydrktmzrbpz1pqh7e

type

string · enum · required

A server's name, metadata, location or settings changed.

Enum values:

server.updated

timestamp

string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version

string · required

The version of the payload format.

Example: v1

object · required

server.updated › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

Example Request Body

{
  "id": "event_01m6v3f5aydrktmzrbpz1pqh7e",
  "type": "server.updated",
  "timestamp": "2024-08-25T15:00:00Z",
  "api_version": "v1",
  "data": {
    "object": {
      "id": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "name": "web-01",
      "hostname": "web-01.example.com",
      "owner_team": {
        "slug": "acme",
        "name": "Acme Inc"
      },
      "access": "owner",
      "tags": [
        {
          "id": "tag_01j8q8zk2f4m6n7p9r1s3t5v7x",
          "name": "production",
          "color": "zinc"
        }
      ],
      "metadata": {
        "key": "string"
      },
      "status": "pending",
      "agent_version": "1.0.0",
      "agent": {
        "version": "1.0.0",
        "update_available": true,
        "auto_updates": {
          "enabled": true,
          "is_default": true
        },
        "capability": {
          "available": true,
          "reason": "installed from a tarball"
        },
        "reboot": {
          "available": true,
          "reason": "running in a Docker container"
        },
        "upgrade_packages": {
          "available": true,
          "reason": "the root helper does not answer"
        },
        "disabled_actions": [
          "reboot"
        ]
      },
      "last_contact_at": "last_contact_at",
      "fqdn": "web-01.example.com",
      "os_family": "debian",
      "os_id": "ubuntu",
      "os_name": "Ubuntu",
      "os_version": "24.04.1",
      "os_codename": "noble",
      "kernel_release": "6.8.0-45-generic",
      "arch": "amd64",
      "virtualization": "guest/kvm",
      "boot_time": "boot_time",
      "cpu_model": "AMD EPYC 7763 64-Core Processor",
      "cpu_cores": 4,
      "cpu_threads": 8,
      "memory_bytes": 17179869184,
      "swap_bytes": 0,
      "disk_bytes": 0,
      "storage_health": "healthy",
      "storage_unhealthy_since": "storage_unhealthy_since",
      "public_ipv4": "203.0.113.10",
      "public_ipv6": "2001:db8::10",
      "observed_ip": "198.51.100.7",
      "nameservers": [
        "string"
      ],
      "addresses": [
        {
          "interface": "eth0",
          "address": "203.0.113.10",
          "prefix": 24,
          "family": 4,
          "scope": "public"
        }
      ],
      "is_os_eol": true,
      "os_eol_at": "os_eol_at",
      "pending_updates_count": 12,
      "security_updates_count": 3,
      "reboot_required": true,
      "updates_checked_at": "updates_checked_at",
      "package_metadata_refresh": {
        "enabled": true,
        "interval": 21600,
        "is_default": true
      },
      "software": [
        {
          "product": "php",
          "version": "7.4.33",
          "package_version": "7.4.33-1+ubuntu16.04.1+deb.sury.org+1",
          "manager": "dpkg",
          "major": 7,
          "minor": 4,
          "patch": 33,
          "package": "php7.4-fpm",
          "source": "package",
          "is_eol": true,
          "eol_at": "eol_at"
        }
      ],
      "provider": "hetzner",
      "city": "Falkenstein",
      "country": "DE",
      "continent": "EU",
      "location_source": "agent",
      "cloud_region": "fsn1",
      "cloud_zone": "fsn1-dc14",
      "instance_type": "m6i.large",
      "asn": 24940,
      "asn_org": "Hetzner Online GmbH",
      "location_override": {
        "provider": "hetzner",
        "city": "Falkenstein",
        "country": "DE",
        "continent": "EU"
      },
      "vhosts_count": 12,
      "certificates_count": 4,
      "certificate_issues_count": 1,
      "repositories": {
        "count": 8,
        "third_party_count": 3,
        "issues_count": 1,
        "orphaned_packages_count": 2,
        "not_covered_packages_count": 4,
        "vendors": [
          {
            "slug": "slug",
            "label": "label",
            "kind": "distro",
            "repositories": 0,
            "issues": [
              "insecure_trusted"
            ]
          }
        ]
      },
      "vulnerabilities": {
        "release": "debian:12",
        "critical": 2,
        "high": 5,
        "medium": 12,
        "low": 20,
        "negligible": 30,
        "unknown": 1,
        "total": 70,
        "fixable": 9,
        "reboot": 1,
        "subscription": 3,
        "released": 0,
        "unfixed": 57,
        "checked_at": "checked_at"
      },
      "enrollment": {
        "token": "scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "install_command": "curl -fsSL https://pkg.server.chief.app/install.sh | sudo bash && sudo serverchief setup scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "expires_at": "expires_at"
      },
      "created_at": "created_at",
      "updated_at": "updated_at"
    }
  }
}

json

server.deleted

POSTyour webhook endpointWebhook

A server was removed.

server.deleted › Headers

webhook-id

string · required

The event's id, the same on every attempt.

webhook-timestamp

string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature

string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

server.deleted › Request Body

ServerDeletedEvent

id

string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: event_01m6v3f5aydrktmzrbpz1pqh7e

type

string · enum · required

A server was removed.

Enum values:

server.deleted

timestamp

string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version

string · required

The version of the payload format.

Example: v1

object · required

server.deleted › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

Example Request Body

{
  "id": "event_01m6v3f5aydrktmzrbpz1pqh7e",
  "type": "server.deleted",
  "timestamp": "2024-08-25T15:00:00Z",
  "api_version": "v1",
  "data": {
    "object": {
      "id": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "name": "web-01",
      "hostname": "web-01.example.com",
      "owner_team": {
        "slug": "acme",
        "name": "Acme Inc"
      },
      "access": "owner",
      "tags": [
        {
          "id": "tag_01j8q8zk2f4m6n7p9r1s3t5v7x",
          "name": "production",
          "color": "zinc"
        }
      ],
      "metadata": {
        "key": "string"
      },
      "status": "pending",
      "agent_version": "1.0.0",
      "agent": {
        "version": "1.0.0",
        "update_available": true,
        "auto_updates": {
          "enabled": true,
          "is_default": true
        },
        "capability": {
          "available": true,
          "reason": "installed from a tarball"
        },
        "reboot": {
          "available": true,
          "reason": "running in a Docker container"
        },
        "upgrade_packages": {
          "available": true,
          "reason": "the root helper does not answer"
        },
        "disabled_actions": [
          "reboot"
        ]
      },
      "last_contact_at": "last_contact_at",
      "fqdn": "web-01.example.com",
      "os_family": "debian",
      "os_id": "ubuntu",
      "os_name": "Ubuntu",
      "os_version": "24.04.1",
      "os_codename": "noble",
      "kernel_release": "6.8.0-45-generic",
      "arch": "amd64",
      "virtualization": "guest/kvm",
      "boot_time": "boot_time",
      "cpu_model": "AMD EPYC 7763 64-Core Processor",
      "cpu_cores": 4,
      "cpu_threads": 8,
      "memory_bytes": 17179869184,
      "swap_bytes": 0,
      "disk_bytes": 0,
      "storage_health": "healthy",
      "storage_unhealthy_since": "storage_unhealthy_since",
      "public_ipv4": "203.0.113.10",
      "public_ipv6": "2001:db8::10",
      "observed_ip": "198.51.100.7",
      "nameservers": [
        "string"
      ],
      "addresses": [
        {
          "interface": "eth0",
          "address": "203.0.113.10",
          "prefix": 24,
          "family": 4,
          "scope": "public"
        }
      ],
      "is_os_eol": true,
      "os_eol_at": "os_eol_at",
      "pending_updates_count": 12,
      "security_updates_count": 3,
      "reboot_required": true,
      "updates_checked_at": "updates_checked_at",
      "package_metadata_refresh": {
        "enabled": true,
        "interval": 21600,
        "is_default": true
      },
      "software": [
        {
          "product": "php",
          "version": "7.4.33",
          "package_version": "7.4.33-1+ubuntu16.04.1+deb.sury.org+1",
          "manager": "dpkg",
          "major": 7,
          "minor": 4,
          "patch": 33,
          "package": "php7.4-fpm",
          "source": "package",
          "is_eol": true,
          "eol_at": "eol_at"
        }
      ],
      "provider": "hetzner",
      "city": "Falkenstein",
      "country": "DE",
      "continent": "EU",
      "location_source": "agent",
      "cloud_region": "fsn1",
      "cloud_zone": "fsn1-dc14",
      "instance_type": "m6i.large",
      "asn": 24940,
      "asn_org": "Hetzner Online GmbH",
      "location_override": {
        "provider": "hetzner",
        "city": "Falkenstein",
        "country": "DE",
        "continent": "EU"
      },
      "vhosts_count": 12,
      "certificates_count": 4,
      "certificate_issues_count": 1,
      "repositories": {
        "count": 8,
        "third_party_count": 3,
        "issues_count": 1,
        "orphaned_packages_count": 2,
        "not_covered_packages_count": 4,
        "vendors": [
          {
            "slug": "slug",
            "label": "label",
            "kind": "distro",
            "repositories": 0,
            "issues": [
              "insecure_trusted"
            ]
          }
        ]
      },
      "vulnerabilities": {
        "release": "debian:12",
        "critical": 2,
        "high": 5,
        "medium": 12,
        "low": 20,
        "negligible": 30,
        "unknown": 1,
        "total": 70,
        "fixable": 9,
        "reboot": 1,
        "subscription": 3,
        "released": 0,
        "unfixed": 57,
        "checked_at": "checked_at"
      },
      "enrollment": {
        "token": "scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "install_command": "curl -fsSL https://pkg.server.chief.app/install.sh | sudo bash && sudo serverchief setup scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "expires_at": "expires_at"
      },
      "created_at": "created_at",
      "updated_at": "updated_at"
    }
  }
}

json

server.offline

POSTyour webhook endpointWebhook

A server stopped checking in.

server.offline › Headers

webhook-id

string · required

The event's id, the same on every attempt.

webhook-timestamp

string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature

string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

server.offline › Request Body

ServerOfflineEvent

id

string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: event_01m6v3f5aydrktmzrbpz1pqh7e

type

string · enum · required

A server stopped checking in.

Enum values:

server.offline

timestamp

string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version

string · required

The version of the payload format.

Example: v1

object · required

server.offline › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

Example Request Body

{
  "id": "event_01m6v3f5aydrktmzrbpz1pqh7e",
  "type": "server.offline",
  "timestamp": "2024-08-25T15:00:00Z",
  "api_version": "v1",
  "data": {
    "object": {
      "id": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "name": "web-01",
      "hostname": "web-01.example.com",
      "owner_team": {
        "slug": "acme",
        "name": "Acme Inc"
      },
      "access": "owner",
      "tags": [
        {
          "id": "tag_01j8q8zk2f4m6n7p9r1s3t5v7x",
          "name": "production",
          "color": "zinc"
        }
      ],
      "metadata": {
        "key": "string"
      },
      "status": "pending",
      "agent_version": "1.0.0",
      "agent": {
        "version": "1.0.0",
        "update_available": true,
        "auto_updates": {
          "enabled": true,
          "is_default": true
        },
        "capability": {
          "available": true,
          "reason": "installed from a tarball"
        },
        "reboot": {
          "available": true,
          "reason": "running in a Docker container"
        },
        "upgrade_packages": {
          "available": true,
          "reason": "the root helper does not answer"
        },
        "disabled_actions": [
          "reboot"
        ]
      },
      "last_contact_at": "last_contact_at",
      "fqdn": "web-01.example.com",
      "os_family": "debian",
      "os_id": "ubuntu",
      "os_name": "Ubuntu",
      "os_version": "24.04.1",
      "os_codename": "noble",
      "kernel_release": "6.8.0-45-generic",
      "arch": "amd64",
      "virtualization": "guest/kvm",
      "boot_time": "boot_time",
      "cpu_model": "AMD EPYC 7763 64-Core Processor",
      "cpu_cores": 4,
      "cpu_threads": 8,
      "memory_bytes": 17179869184,
      "swap_bytes": 0,
      "disk_bytes": 0,
      "storage_health": "healthy",
      "storage_unhealthy_since": "storage_unhealthy_since",
      "public_ipv4": "203.0.113.10",
      "public_ipv6": "2001:db8::10",
      "observed_ip": "198.51.100.7",
      "nameservers": [
        "string"
      ],
      "addresses": [
        {
          "interface": "eth0",
          "address": "203.0.113.10",
          "prefix": 24,
          "family": 4,
          "scope": "public"
        }
      ],
      "is_os_eol": true,
      "os_eol_at": "os_eol_at",
      "pending_updates_count": 12,
      "security_updates_count": 3,
      "reboot_required": true,
      "updates_checked_at": "updates_checked_at",
      "package_metadata_refresh": {
        "enabled": true,
        "interval": 21600,
        "is_default": true
      },
      "software": [
        {
          "product": "php",
          "version": "7.4.33",
          "package_version": "7.4.33-1+ubuntu16.04.1+deb.sury.org+1",
          "manager": "dpkg",
          "major": 7,
          "minor": 4,
          "patch": 33,
          "package": "php7.4-fpm",
          "source": "package",
          "is_eol": true,
          "eol_at": "eol_at"
        }
      ],
      "provider": "hetzner",
      "city": "Falkenstein",
      "country": "DE",
      "continent": "EU",
      "location_source": "agent",
      "cloud_region": "fsn1",
      "cloud_zone": "fsn1-dc14",
      "instance_type": "m6i.large",
      "asn": 24940,
      "asn_org": "Hetzner Online GmbH",
      "location_override": {
        "provider": "hetzner",
        "city": "Falkenstein",
        "country": "DE",
        "continent": "EU"
      },
      "vhosts_count": 12,
      "certificates_count": 4,
      "certificate_issues_count": 1,
      "repositories": {
        "count": 8,
        "third_party_count": 3,
        "issues_count": 1,
        "orphaned_packages_count": 2,
        "not_covered_packages_count": 4,
        "vendors": [
          {
            "slug": "slug",
            "label": "label",
            "kind": "distro",
            "repositories": 0,
            "issues": [
              "insecure_trusted"
            ]
          }
        ]
      },
      "vulnerabilities": {
        "release": "debian:12",
        "critical": 2,
        "high": 5,
        "medium": 12,
        "low": 20,
        "negligible": 30,
        "unknown": 1,
        "total": 70,
        "fixable": 9,
        "reboot": 1,
        "subscription": 3,
        "released": 0,
        "unfixed": 57,
        "checked_at": "checked_at"
      },
      "enrollment": {
        "token": "scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "install_command": "curl -fsSL https://pkg.server.chief.app/install.sh | sudo bash && sudo serverchief setup scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "expires_at": "expires_at"
      },
      "created_at": "created_at",
      "updated_at": "updated_at"
    }
  }
}

json

server.online

POSTyour webhook endpointWebhook

An offline server checks in again.

server.online › Headers

webhook-id

string · required

The event's id, the same on every attempt.

webhook-timestamp

string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature

string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

server.online › Request Body

ServerOnlineEvent

id

string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: event_01m6v3f5aydrktmzrbpz1pqh7e

type

string · enum · required

An offline server checks in again.

Enum values:

server.online

timestamp

string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version

string · required

The version of the payload format.

Example: v1

object · required

server.online › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

Example Request Body

{
  "id": "event_01m6v3f5aydrktmzrbpz1pqh7e",
  "type": "server.online",
  "timestamp": "2024-08-25T15:00:00Z",
  "api_version": "v1",
  "data": {
    "object": {
      "id": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "name": "web-01",
      "hostname": "web-01.example.com",
      "owner_team": {
        "slug": "acme",
        "name": "Acme Inc"
      },
      "access": "owner",
      "tags": [
        {
          "id": "tag_01j8q8zk2f4m6n7p9r1s3t5v7x",
          "name": "production",
          "color": "zinc"
        }
      ],
      "metadata": {
        "key": "string"
      },
      "status": "pending",
      "agent_version": "1.0.0",
      "agent": {
        "version": "1.0.0",
        "update_available": true,
        "auto_updates": {
          "enabled": true,
          "is_default": true
        },
        "capability": {
          "available": true,
          "reason": "installed from a tarball"
        },
        "reboot": {
          "available": true,
          "reason": "running in a Docker container"
        },
        "upgrade_packages": {
          "available": true,
          "reason": "the root helper does not answer"
        },
        "disabled_actions": [
          "reboot"
        ]
      },
      "last_contact_at": "last_contact_at",
      "fqdn": "web-01.example.com",
      "os_family": "debian",
      "os_id": "ubuntu",
      "os_name": "Ubuntu",
      "os_version": "24.04.1",
      "os_codename": "noble",
      "kernel_release": "6.8.0-45-generic",
      "arch": "amd64",
      "virtualization": "guest/kvm",
      "boot_time": "boot_time",
      "cpu_model": "AMD EPYC 7763 64-Core Processor",
      "cpu_cores": 4,
      "cpu_threads": 8,
      "memory_bytes": 17179869184,
      "swap_bytes": 0,
      "disk_bytes": 0,
      "storage_health": "healthy",
      "storage_unhealthy_since": "storage_unhealthy_since",
      "public_ipv4": "203.0.113.10",
      "public_ipv6": "2001:db8::10",
      "observed_ip": "198.51.100.7",
      "nameservers": [
        "string"
      ],
      "addresses": [
        {
          "interface": "eth0",
          "address": "203.0.113.10",
          "prefix": 24,
          "family": 4,
          "scope": "public"
        }
      ],
      "is_os_eol": true,
      "os_eol_at": "os_eol_at",
      "pending_updates_count": 12,
      "security_updates_count": 3,
      "reboot_required": true,
      "updates_checked_at": "updates_checked_at",
      "package_metadata_refresh": {
        "enabled": true,
        "interval": 21600,
        "is_default": true
      },
      "software": [
        {
          "product": "php",
          "version": "7.4.33",
          "package_version": "7.4.33-1+ubuntu16.04.1+deb.sury.org+1",
          "manager": "dpkg",
          "major": 7,
          "minor": 4,
          "patch": 33,
          "package": "php7.4-fpm",
          "source": "package",
          "is_eol": true,
          "eol_at": "eol_at"
        }
      ],
      "provider": "hetzner",
      "city": "Falkenstein",
      "country": "DE",
      "continent": "EU",
      "location_source": "agent",
      "cloud_region": "fsn1",
      "cloud_zone": "fsn1-dc14",
      "instance_type": "m6i.large",
      "asn": 24940,
      "asn_org": "Hetzner Online GmbH",
      "location_override": {
        "provider": "hetzner",
        "city": "Falkenstein",
        "country": "DE",
        "continent": "EU"
      },
      "vhosts_count": 12,
      "certificates_count": 4,
      "certificate_issues_count": 1,
      "repositories": {
        "count": 8,
        "third_party_count": 3,
        "issues_count": 1,
        "orphaned_packages_count": 2,
        "not_covered_packages_count": 4,
        "vendors": [
          {
            "slug": "slug",
            "label": "label",
            "kind": "distro",
            "repositories": 0,
            "issues": [
              "insecure_trusted"
            ]
          }
        ]
      },
      "vulnerabilities": {
        "release": "debian:12",
        "critical": 2,
        "high": 5,
        "medium": 12,
        "low": 20,
        "negligible": 30,
        "unknown": 1,
        "total": 70,
        "fixable": 9,
        "reboot": 1,
        "subscription": 3,
        "released": 0,
        "unfixed": 57,
        "checked_at": "checked_at"
      },
      "enrollment": {
        "token": "scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "install_command": "curl -fsSL https://pkg.server.chief.app/install.sh | sudo bash && sudo serverchief setup scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "expires_at": "expires_at"
      },
      "created_at": "created_at",
      "updated_at": "updated_at"
    },
    "offline_since": "2024-08-25T15:00:00Z"
  }
}

json

server.reboot_stalled

POSTyour webhook endpointWebhook

A server did not come back after a reboot.

server.reboot_stalled › Headers

webhook-id

string · required

The event's id, the same on every attempt.

webhook-timestamp

string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature

string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

server.reboot_stalled › Request Body

ServerRebootStalledEvent

id

string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: event_01m6v3f5aydrktmzrbpz1pqh7e

type

string · enum · required

A server did not come back after a reboot.

Enum values:

server.reboot_stalled

timestamp

string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version

string · required

The version of the payload format.

Example: v1

object · required

server.reboot_stalled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

Example Request Body

{
  "id": "event_01m6v3f5aydrktmzrbpz1pqh7e",
  "type": "server.reboot_stalled",
  "timestamp": "2024-08-25T15:00:00Z",
  "api_version": "v1",
  "data": {
    "object": {
      "id": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "name": "web-01",
      "hostname": "web-01.example.com",
      "owner_team": {
        "slug": "acme",
        "name": "Acme Inc"
      },
      "access": "owner",
      "tags": [
        {
          "id": "tag_01j8q8zk2f4m6n7p9r1s3t5v7x",
          "name": "production",
          "color": "zinc"
        }
      ],
      "metadata": {
        "key": "string"
      },
      "status": "pending",
      "agent_version": "1.0.0",
      "agent": {
        "version": "1.0.0",
        "update_available": true,
        "auto_updates": {
          "enabled": true,
          "is_default": true
        },
        "capability": {
          "available": true,
          "reason": "installed from a tarball"
        },
        "reboot": {
          "available": true,
          "reason": "running in a Docker container"
        },
        "upgrade_packages": {
          "available": true,
          "reason": "the root helper does not answer"
        },
        "disabled_actions": [
          "reboot"
        ]
      },
      "last_contact_at": "last_contact_at",
      "fqdn": "web-01.example.com",
      "os_family": "debian",
      "os_id": "ubuntu",
      "os_name": "Ubuntu",
      "os_version": "24.04.1",
      "os_codename": "noble",
      "kernel_release": "6.8.0-45-generic",
      "arch": "amd64",
      "virtualization": "guest/kvm",
      "boot_time": "boot_time",
      "cpu_model": "AMD EPYC 7763 64-Core Processor",
      "cpu_cores": 4,
      "cpu_threads": 8,
      "memory_bytes": 17179869184,
      "swap_bytes": 0,
      "disk_bytes": 0,
      "storage_health": "healthy",
      "storage_unhealthy_since": "storage_unhealthy_since",
      "public_ipv4": "203.0.113.10",
      "public_ipv6": "2001:db8::10",
      "observed_ip": "198.51.100.7",
      "nameservers": [
        "string"
      ],
      "addresses": [
        {
          "interface": "eth0",
          "address": "203.0.113.10",
          "prefix": 24,
          "family": 4,
          "scope": "public"
        }
      ],
      "is_os_eol": true,
      "os_eol_at": "os_eol_at",
      "pending_updates_count": 12,
      "security_updates_count": 3,
      "reboot_required": true,
      "updates_checked_at": "updates_checked_at",
      "package_metadata_refresh": {
        "enabled": true,
        "interval": 21600,
        "is_default": true
      },
      "software": [
        {
          "product": "php",
          "version": "7.4.33",
          "package_version": "7.4.33-1+ubuntu16.04.1+deb.sury.org+1",
          "manager": "dpkg",
          "major": 7,
          "minor": 4,
          "patch": 33,
          "package": "php7.4-fpm",
          "source": "package",
          "is_eol": true,
          "eol_at": "eol_at"
        }
      ],
      "provider": "hetzner",
      "city": "Falkenstein",
      "country": "DE",
      "continent": "EU",
      "location_source": "agent",
      "cloud_region": "fsn1",
      "cloud_zone": "fsn1-dc14",
      "instance_type": "m6i.large",
      "asn": 24940,
      "asn_org": "Hetzner Online GmbH",
      "location_override": {
        "provider": "hetzner",
        "city": "Falkenstein",
        "country": "DE",
        "continent": "EU"
      },
      "vhosts_count": 12,
      "certificates_count": 4,
      "certificate_issues_count": 1,
      "repositories": {
        "count": 8,
        "third_party_count": 3,
        "issues_count": 1,
        "orphaned_packages_count": 2,
        "not_covered_packages_count": 4,
        "vendors": [
          {
            "slug": "slug",
            "label": "label",
            "kind": "distro",
            "repositories": 0,
            "issues": [
              "insecure_trusted"
            ]
          }
        ]
      },
      "vulnerabilities": {
        "release": "debian:12",
        "critical": 2,
        "high": 5,
        "medium": 12,
        "low": 20,
        "negligible": 30,
        "unknown": 1,
        "total": 70,
        "fixable": 9,
        "reboot": 1,
        "subscription": 3,
        "released": 0,
        "unfixed": 57,
        "checked_at": "checked_at"
      },
      "enrollment": {
        "token": "scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "install_command": "curl -fsSL https://pkg.server.chief.app/install.sh | sudo bash && sudo serverchief setup scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "expires_at": "expires_at"
      },
      "created_at": "created_at",
      "updated_at": "updated_at"
    },
    "command_id": "command_id"
  }
}

json

alert.fired

POSTyour webhook endpointWebhook

A metric alert rule fired.

alert.fired › Headers

webhook-id

string · required

The event's id, the same on every attempt.

webhook-timestamp

string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature

string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

alert.fired › Request Body

AlertFiredEvent

id

string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: event_01m6v3f5aydrktmzrbpz1pqh7e

type

string · enum · required

A metric alert rule fired.

Enum values:

alert.fired

timestamp

string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version

string · required

The version of the payload format.

Example: v1

object · required

alert.fired › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

Example Request Body

{
  "id": "event_01m6v3f5aydrktmzrbpz1pqh7e",
  "type": "alert.fired",
  "timestamp": "2024-08-25T15:00:00Z",
  "api_version": "v1",
  "data": {
    "object": {
      "id": "alert_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "status": "firing",
      "server": {
        "id": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
        "name": "web-01"
      },
      "rule_id": "rule_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "rule_description": "Disk space used above 90% for 10 minutes",
      "metric": "cpu_used",
      "condition": "above",
      "duration_minutes": 10,
      "instance": "/var",
      "unit": "%",
      "baseline_value": 120.5,
      "threshold_value": 90,
      "value": 93.2,
      "peak_value": 95.1,
      "description": "Disk space used on /var is 93.2%",
      "fired_at": "fired_at",
      "resolved_at": "resolved_at",
      "closed_reason": "closed_reason"
    }
  }
}

json

alert.resolved

POSTyour webhook endpointWebhook

A firing alert resolved.

alert.resolved › Headers

webhook-id

string · required

The event's id, the same on every attempt.

webhook-timestamp

string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature

string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

alert.resolved › Request Body

AlertResolvedEvent

id

string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: event_01m6v3f5aydrktmzrbpz1pqh7e

type

string · enum · required

A firing alert resolved.

Enum values:

alert.resolved

timestamp

string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version

string · required

The version of the payload format.

Example: v1

object · required

alert.resolved › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

Example Request Body

{
  "id": "event_01m6v3f5aydrktmzrbpz1pqh7e",
  "type": "alert.resolved",
  "timestamp": "2024-08-25T15:00:00Z",
  "api_version": "v1",
  "data": {
    "object": {
      "id": "alert_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "status": "firing",
      "server": {
        "id": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
        "name": "web-01"
      },
      "rule_id": "rule_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "rule_description": "Disk space used above 90% for 10 minutes",
      "metric": "cpu_used",
      "condition": "above",
      "duration_minutes": 10,
      "instance": "/var",
      "unit": "%",
      "baseline_value": 120.5,
      "threshold_value": 90,
      "value": 93.2,
      "peak_value": 95.1,
      "description": "Disk space used on /var is 93.2%",
      "fired_at": "fired_at",
      "resolved_at": "resolved_at",
      "closed_reason": "closed_reason"
    },
    "reason": "recovered"
  }
}

json

metrics.stalled

POSTyour webhook endpointWebhook

An online server stopped delivering metrics.

metrics.stalled › Headers

webhook-id

string · required

The event's id, the same on every attempt.

webhook-timestamp

string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature

string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

metrics.stalled › Request Body

MetricsStalledEvent

id

string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: event_01m6v3f5aydrktmzrbpz1pqh7e

type

string · enum · required

An online server stopped delivering metrics.

Enum values:

metrics.stalled

timestamp

string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version

string · required

The version of the payload format.

Example: v1

object · required

metrics.stalled › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

Example Request Body

{
  "id": "event_01m6v3f5aydrktmzrbpz1pqh7e",
  "type": "metrics.stalled",
  "timestamp": "2024-08-25T15:00:00Z",
  "api_version": "v1",
  "data": {
    "object": {
      "id": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "name": "web-01",
      "hostname": "web-01.example.com",
      "owner_team": {
        "slug": "acme",
        "name": "Acme Inc"
      },
      "access": "owner",
      "tags": [
        {
          "id": "tag_01j8q8zk2f4m6n7p9r1s3t5v7x",
          "name": "production",
          "color": "zinc"
        }
      ],
      "metadata": {
        "key": "string"
      },
      "status": "pending",
      "agent_version": "1.0.0",
      "agent": {
        "version": "1.0.0",
        "update_available": true,
        "auto_updates": {
          "enabled": true,
          "is_default": true
        },
        "capability": {
          "available": true,
          "reason": "installed from a tarball"
        },
        "reboot": {
          "available": true,
          "reason": "running in a Docker container"
        },
        "upgrade_packages": {
          "available": true,
          "reason": "the root helper does not answer"
        },
        "disabled_actions": [
          "reboot"
        ]
      },
      "last_contact_at": "last_contact_at",
      "fqdn": "web-01.example.com",
      "os_family": "debian",
      "os_id": "ubuntu",
      "os_name": "Ubuntu",
      "os_version": "24.04.1",
      "os_codename": "noble",
      "kernel_release": "6.8.0-45-generic",
      "arch": "amd64",
      "virtualization": "guest/kvm",
      "boot_time": "boot_time",
      "cpu_model": "AMD EPYC 7763 64-Core Processor",
      "cpu_cores": 4,
      "cpu_threads": 8,
      "memory_bytes": 17179869184,
      "swap_bytes": 0,
      "disk_bytes": 0,
      "storage_health": "healthy",
      "storage_unhealthy_since": "storage_unhealthy_since",
      "public_ipv4": "203.0.113.10",
      "public_ipv6": "2001:db8::10",
      "observed_ip": "198.51.100.7",
      "nameservers": [
        "string"
      ],
      "addresses": [
        {
          "interface": "eth0",
          "address": "203.0.113.10",
          "prefix": 24,
          "family": 4,
          "scope": "public"
        }
      ],
      "is_os_eol": true,
      "os_eol_at": "os_eol_at",
      "pending_updates_count": 12,
      "security_updates_count": 3,
      "reboot_required": true,
      "updates_checked_at": "updates_checked_at",
      "package_metadata_refresh": {
        "enabled": true,
        "interval": 21600,
        "is_default": true
      },
      "software": [
        {
          "product": "php",
          "version": "7.4.33",
          "package_version": "7.4.33-1+ubuntu16.04.1+deb.sury.org+1",
          "manager": "dpkg",
          "major": 7,
          "minor": 4,
          "patch": 33,
          "package": "php7.4-fpm",
          "source": "package",
          "is_eol": true,
          "eol_at": "eol_at"
        }
      ],
      "provider": "hetzner",
      "city": "Falkenstein",
      "country": "DE",
      "continent": "EU",
      "location_source": "agent",
      "cloud_region": "fsn1",
      "cloud_zone": "fsn1-dc14",
      "instance_type": "m6i.large",
      "asn": 24940,
      "asn_org": "Hetzner Online GmbH",
      "location_override": {
        "provider": "hetzner",
        "city": "Falkenstein",
        "country": "DE",
        "continent": "EU"
      },
      "vhosts_count": 12,
      "certificates_count": 4,
      "certificate_issues_count": 1,
      "repositories": {
        "count": 8,
        "third_party_count": 3,
        "issues_count": 1,
        "orphaned_packages_count": 2,
        "not_covered_packages_count": 4,
        "vendors": [
          {
            "slug": "slug",
            "label": "label",
            "kind": "distro",
            "repositories": 0,
            "issues": [
              "insecure_trusted"
            ]
          }
        ]
      },
      "vulnerabilities": {
        "release": "debian:12",
        "critical": 2,
        "high": 5,
        "medium": 12,
        "low": 20,
        "negligible": 30,
        "unknown": 1,
        "total": 70,
        "fixable": 9,
        "reboot": 1,
        "subscription": 3,
        "released": 0,
        "unfixed": 57,
        "checked_at": "checked_at"
      },
      "enrollment": {
        "token": "scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "install_command": "curl -fsSL https://pkg.server.chief.app/install.sh | sudo bash && sudo serverchief setup scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "expires_at": "expires_at"
      },
      "created_at": "created_at",
      "updated_at": "updated_at"
    },
    "stalled_at": "2024-08-25T15:00:00Z"
  }
}

json

metrics.resumed

POSTyour webhook endpointWebhook

A server delivers metrics again.

metrics.resumed › Headers

webhook-id

string · required

The event's id, the same on every attempt.

webhook-timestamp

string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature

string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

metrics.resumed › Request Body

MetricsResumedEvent

id

string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: event_01m6v3f5aydrktmzrbpz1pqh7e

type

string · enum · required

A server delivers metrics again.

Enum values:

metrics.resumed

timestamp

string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version

string · required

The version of the payload format.

Example: v1

object · required

metrics.resumed › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

Example Request Body

{
  "id": "event_01m6v3f5aydrktmzrbpz1pqh7e",
  "type": "metrics.resumed",
  "timestamp": "2024-08-25T15:00:00Z",
  "api_version": "v1",
  "data": {
    "object": {
      "id": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "name": "web-01",
      "hostname": "web-01.example.com",
      "owner_team": {
        "slug": "acme",
        "name": "Acme Inc"
      },
      "access": "owner",
      "tags": [
        {
          "id": "tag_01j8q8zk2f4m6n7p9r1s3t5v7x",
          "name": "production",
          "color": "zinc"
        }
      ],
      "metadata": {
        "key": "string"
      },
      "status": "pending",
      "agent_version": "1.0.0",
      "agent": {
        "version": "1.0.0",
        "update_available": true,
        "auto_updates": {
          "enabled": true,
          "is_default": true
        },
        "capability": {
          "available": true,
          "reason": "installed from a tarball"
        },
        "reboot": {
          "available": true,
          "reason": "running in a Docker container"
        },
        "upgrade_packages": {
          "available": true,
          "reason": "the root helper does not answer"
        },
        "disabled_actions": [
          "reboot"
        ]
      },
      "last_contact_at": "last_contact_at",
      "fqdn": "web-01.example.com",
      "os_family": "debian",
      "os_id": "ubuntu",
      "os_name": "Ubuntu",
      "os_version": "24.04.1",
      "os_codename": "noble",
      "kernel_release": "6.8.0-45-generic",
      "arch": "amd64",
      "virtualization": "guest/kvm",
      "boot_time": "boot_time",
      "cpu_model": "AMD EPYC 7763 64-Core Processor",
      "cpu_cores": 4,
      "cpu_threads": 8,
      "memory_bytes": 17179869184,
      "swap_bytes": 0,
      "disk_bytes": 0,
      "storage_health": "healthy",
      "storage_unhealthy_since": "storage_unhealthy_since",
      "public_ipv4": "203.0.113.10",
      "public_ipv6": "2001:db8::10",
      "observed_ip": "198.51.100.7",
      "nameservers": [
        "string"
      ],
      "addresses": [
        {
          "interface": "eth0",
          "address": "203.0.113.10",
          "prefix": 24,
          "family": 4,
          "scope": "public"
        }
      ],
      "is_os_eol": true,
      "os_eol_at": "os_eol_at",
      "pending_updates_count": 12,
      "security_updates_count": 3,
      "reboot_required": true,
      "updates_checked_at": "updates_checked_at",
      "package_metadata_refresh": {
        "enabled": true,
        "interval": 21600,
        "is_default": true
      },
      "software": [
        {
          "product": "php",
          "version": "7.4.33",
          "package_version": "7.4.33-1+ubuntu16.04.1+deb.sury.org+1",
          "manager": "dpkg",
          "major": 7,
          "minor": 4,
          "patch": 33,
          "package": "php7.4-fpm",
          "source": "package",
          "is_eol": true,
          "eol_at": "eol_at"
        }
      ],
      "provider": "hetzner",
      "city": "Falkenstein",
      "country": "DE",
      "continent": "EU",
      "location_source": "agent",
      "cloud_region": "fsn1",
      "cloud_zone": "fsn1-dc14",
      "instance_type": "m6i.large",
      "asn": 24940,
      "asn_org": "Hetzner Online GmbH",
      "location_override": {
        "provider": "hetzner",
        "city": "Falkenstein",
        "country": "DE",
        "continent": "EU"
      },
      "vhosts_count": 12,
      "certificates_count": 4,
      "certificate_issues_count": 1,
      "repositories": {
        "count": 8,
        "third_party_count": 3,
        "issues_count": 1,
        "orphaned_packages_count": 2,
        "not_covered_packages_count": 4,
        "vendors": [
          {
            "slug": "slug",
            "label": "label",
            "kind": "distro",
            "repositories": 0,
            "issues": [
              "insecure_trusted"
            ]
          }
        ]
      },
      "vulnerabilities": {
        "release": "debian:12",
        "critical": 2,
        "high": 5,
        "medium": 12,
        "low": 20,
        "negligible": 30,
        "unknown": 1,
        "total": 70,
        "fixable": 9,
        "reboot": 1,
        "subscription": 3,
        "released": 0,
        "unfixed": 57,
        "checked_at": "checked_at"
      },
      "enrollment": {
        "token": "scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "install_command": "curl -fsSL https://pkg.server.chief.app/install.sh | sudo bash && sudo serverchief setup scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "expires_at": "expires_at"
      },
      "created_at": "created_at",
      "updated_at": "updated_at"
    },
    "stalled_at": "2024-08-25T15:00:00Z"
  }
}

json

server.storage_unhealthy

POSTyour webhook endpointWebhook

A RAID array or ZFS pool degraded, or a disk failed.

server.storage_unhealthy › Headers

webhook-id

string · required

The event's id, the same on every attempt.

webhook-timestamp

string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature

string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

server.storage_unhealthy › Request Body

ServerStorageUnhealthyEvent

id

string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: event_01m6v3f5aydrktmzrbpz1pqh7e

type

string · enum · required

A RAID array or ZFS pool degraded, or a disk failed.

Enum values:

server.storage_unhealthy

timestamp

string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version

string · required

The version of the payload format.

Example: v1

object · required

server.storage_unhealthy › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

Example Request Body

{
  "id": "event_01m6v3f5aydrktmzrbpz1pqh7e",
  "type": "server.storage_unhealthy",
  "timestamp": "2024-08-25T15:00:00Z",
  "api_version": "v1",
  "data": {
    "object": {
      "id": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "name": "web-01",
      "hostname": "web-01.example.com",
      "owner_team": {
        "slug": "acme",
        "name": "Acme Inc"
      },
      "access": "owner",
      "tags": [
        {
          "id": "tag_01j8q8zk2f4m6n7p9r1s3t5v7x",
          "name": "production",
          "color": "zinc"
        }
      ],
      "metadata": {
        "key": "string"
      },
      "status": "pending",
      "agent_version": "1.0.0",
      "agent": {
        "version": "1.0.0",
        "update_available": true,
        "auto_updates": {
          "enabled": true,
          "is_default": true
        },
        "capability": {
          "available": true,
          "reason": "installed from a tarball"
        },
        "reboot": {
          "available": true,
          "reason": "running in a Docker container"
        },
        "upgrade_packages": {
          "available": true,
          "reason": "the root helper does not answer"
        },
        "disabled_actions": [
          "reboot"
        ]
      },
      "last_contact_at": "last_contact_at",
      "fqdn": "web-01.example.com",
      "os_family": "debian",
      "os_id": "ubuntu",
      "os_name": "Ubuntu",
      "os_version": "24.04.1",
      "os_codename": "noble",
      "kernel_release": "6.8.0-45-generic",
      "arch": "amd64",
      "virtualization": "guest/kvm",
      "boot_time": "boot_time",
      "cpu_model": "AMD EPYC 7763 64-Core Processor",
      "cpu_cores": 4,
      "cpu_threads": 8,
      "memory_bytes": 17179869184,
      "swap_bytes": 0,
      "disk_bytes": 0,
      "storage_health": "healthy",
      "storage_unhealthy_since": "storage_unhealthy_since",
      "public_ipv4": "203.0.113.10",
      "public_ipv6": "2001:db8::10",
      "observed_ip": "198.51.100.7",
      "nameservers": [
        "string"
      ],
      "addresses": [
        {
          "interface": "eth0",
          "address": "203.0.113.10",
          "prefix": 24,
          "family": 4,
          "scope": "public"
        }
      ],
      "is_os_eol": true,
      "os_eol_at": "os_eol_at",
      "pending_updates_count": 12,
      "security_updates_count": 3,
      "reboot_required": true,
      "updates_checked_at": "updates_checked_at",
      "package_metadata_refresh": {
        "enabled": true,
        "interval": 21600,
        "is_default": true
      },
      "software": [
        {
          "product": "php",
          "version": "7.4.33",
          "package_version": "7.4.33-1+ubuntu16.04.1+deb.sury.org+1",
          "manager": "dpkg",
          "major": 7,
          "minor": 4,
          "patch": 33,
          "package": "php7.4-fpm",
          "source": "package",
          "is_eol": true,
          "eol_at": "eol_at"
        }
      ],
      "provider": "hetzner",
      "city": "Falkenstein",
      "country": "DE",
      "continent": "EU",
      "location_source": "agent",
      "cloud_region": "fsn1",
      "cloud_zone": "fsn1-dc14",
      "instance_type": "m6i.large",
      "asn": 24940,
      "asn_org": "Hetzner Online GmbH",
      "location_override": {
        "provider": "hetzner",
        "city": "Falkenstein",
        "country": "DE",
        "continent": "EU"
      },
      "vhosts_count": 12,
      "certificates_count": 4,
      "certificate_issues_count": 1,
      "repositories": {
        "count": 8,
        "third_party_count": 3,
        "issues_count": 1,
        "orphaned_packages_count": 2,
        "not_covered_packages_count": 4,
        "vendors": [
          {
            "slug": "slug",
            "label": "label",
            "kind": "distro",
            "repositories": 0,
            "issues": [
              "insecure_trusted"
            ]
          }
        ]
      },
      "vulnerabilities": {
        "release": "debian:12",
        "critical": 2,
        "high": 5,
        "medium": 12,
        "low": 20,
        "negligible": 30,
        "unknown": 1,
        "total": 70,
        "fixable": 9,
        "reboot": 1,
        "subscription": 3,
        "released": 0,
        "unfixed": 57,
        "checked_at": "checked_at"
      },
      "enrollment": {
        "token": "scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "install_command": "curl -fsSL https://pkg.server.chief.app/install.sh | sudo bash && sudo serverchief setup scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "expires_at": "expires_at"
      },
      "created_at": "created_at",
      "updated_at": "updated_at"
    },
    "health": "healthy",
    "problems": [
      {
        "health": "healthy",
        "subject": "subject",
        "description": "description"
      }
    ],
    "unhealthy_since": "2024-08-25T15:00:00Z"
  }
}

json

server.storage_healthy

POSTyour webhook endpointWebhook

A server's storage is healthy again.

server.storage_healthy › Headers

webhook-id

string · required

The event's id, the same on every attempt.

webhook-timestamp

string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature

string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

server.storage_healthy › Request Body

ServerStorageHealthyEvent

id

string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: event_01m6v3f5aydrktmzrbpz1pqh7e

type

string · enum · required

A server's storage is healthy again.

Enum values:

server.storage_healthy

timestamp

string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version

string · required

The version of the payload format.

Example: v1

object · required

server.storage_healthy › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

Example Request Body

{
  "id": "event_01m6v3f5aydrktmzrbpz1pqh7e",
  "type": "server.storage_healthy",
  "timestamp": "2024-08-25T15:00:00Z",
  "api_version": "v1",
  "data": {
    "object": {
      "id": "server_01j8q8zk2f4m6n7p9r1s3t5v7x",
      "name": "web-01",
      "hostname": "web-01.example.com",
      "owner_team": {
        "slug": "acme",
        "name": "Acme Inc"
      },
      "access": "owner",
      "tags": [
        {
          "id": "tag_01j8q8zk2f4m6n7p9r1s3t5v7x",
          "name": "production",
          "color": "zinc"
        }
      ],
      "metadata": {
        "key": "string"
      },
      "status": "pending",
      "agent_version": "1.0.0",
      "agent": {
        "version": "1.0.0",
        "update_available": true,
        "auto_updates": {
          "enabled": true,
          "is_default": true
        },
        "capability": {
          "available": true,
          "reason": "installed from a tarball"
        },
        "reboot": {
          "available": true,
          "reason": "running in a Docker container"
        },
        "upgrade_packages": {
          "available": true,
          "reason": "the root helper does not answer"
        },
        "disabled_actions": [
          "reboot"
        ]
      },
      "last_contact_at": "last_contact_at",
      "fqdn": "web-01.example.com",
      "os_family": "debian",
      "os_id": "ubuntu",
      "os_name": "Ubuntu",
      "os_version": "24.04.1",
      "os_codename": "noble",
      "kernel_release": "6.8.0-45-generic",
      "arch": "amd64",
      "virtualization": "guest/kvm",
      "boot_time": "boot_time",
      "cpu_model": "AMD EPYC 7763 64-Core Processor",
      "cpu_cores": 4,
      "cpu_threads": 8,
      "memory_bytes": 17179869184,
      "swap_bytes": 0,
      "disk_bytes": 0,
      "storage_health": "healthy",
      "storage_unhealthy_since": "storage_unhealthy_since",
      "public_ipv4": "203.0.113.10",
      "public_ipv6": "2001:db8::10",
      "observed_ip": "198.51.100.7",
      "nameservers": [
        "string"
      ],
      "addresses": [
        {
          "interface": "eth0",
          "address": "203.0.113.10",
          "prefix": 24,
          "family": 4,
          "scope": "public"
        }
      ],
      "is_os_eol": true,
      "os_eol_at": "os_eol_at",
      "pending_updates_count": 12,
      "security_updates_count": 3,
      "reboot_required": true,
      "updates_checked_at": "updates_checked_at",
      "package_metadata_refresh": {
        "enabled": true,
        "interval": 21600,
        "is_default": true
      },
      "software": [
        {
          "product": "php",
          "version": "7.4.33",
          "package_version": "7.4.33-1+ubuntu16.04.1+deb.sury.org+1",
          "manager": "dpkg",
          "major": 7,
          "minor": 4,
          "patch": 33,
          "package": "php7.4-fpm",
          "source": "package",
          "is_eol": true,
          "eol_at": "eol_at"
        }
      ],
      "provider": "hetzner",
      "city": "Falkenstein",
      "country": "DE",
      "continent": "EU",
      "location_source": "agent",
      "cloud_region": "fsn1",
      "cloud_zone": "fsn1-dc14",
      "instance_type": "m6i.large",
      "asn": 24940,
      "asn_org": "Hetzner Online GmbH",
      "location_override": {
        "provider": "hetzner",
        "city": "Falkenstein",
        "country": "DE",
        "continent": "EU"
      },
      "vhosts_count": 12,
      "certificates_count": 4,
      "certificate_issues_count": 1,
      "repositories": {
        "count": 8,
        "third_party_count": 3,
        "issues_count": 1,
        "orphaned_packages_count": 2,
        "not_covered_packages_count": 4,
        "vendors": [
          {
            "slug": "slug",
            "label": "label",
            "kind": "distro",
            "repositories": 0,
            "issues": [
              "insecure_trusted"
            ]
          }
        ]
      },
      "vulnerabilities": {
        "release": "debian:12",
        "critical": 2,
        "high": 5,
        "medium": 12,
        "low": 20,
        "negligible": 30,
        "unknown": 1,
        "total": 70,
        "fixable": 9,
        "reboot": 1,
        "subscription": 3,
        "released": 0,
        "unfixed": 57,
        "checked_at": "checked_at"
      },
      "enrollment": {
        "token": "scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "install_command": "curl -fsSL https://pkg.server.chief.app/install.sh | sudo bash && sudo serverchief setup scenr_4Jd8sKq2LmN7pR1tV5xZ9bC3fG6hJ0kM8nQ2wE",
        "expires_at": "expires_at"
      },
      "created_at": "created_at",
      "updated_at": "updated_at"
    },
    "unhealthy_since": "2024-08-25T15:00:00Z"
  }
}

json

webhook_endpoint.test

POSTyour webhook endpointWebhook

A test event sent from the dashboard.

webhook_endpoint.test › Headers

webhook-id

string · required

The event's id, the same on every attempt.

webhook-timestamp

string · required

The Unix time this attempt was sent, reject requests more than five minutes from your clock.

webhook-signature

string · required

Space-separated v1,{base64} HMAC-SHA256 signatures of {webhook-id}.{webhook-timestamp}.{body}, following Standard Webhooks. Two while a rotated secret is still valid.

webhook_endpoint.test › Request Body

WebhookEndpointTestEvent

id

string · required

Identifies the event, the same as the webhook-id header. It stays the same on retries and resends, use it to skip events you processed.

Example: event_01m6v3f5aydrktmzrbpz1pqh7e

type

string · enum · required

A test event sent from the dashboard.

Enum values:

webhook_endpoint.test

timestamp

string · date-time · required

When the event happened, in UTC. It does not change on retries.

api_version

string · required

The version of the payload format.

Example: v1

object · required

webhook_endpoint.test › Responses

Any 2xx status within 15 seconds acknowledges the delivery. Any other status, a timeout or a redirect fails it, and it is retried.

No data returned

Webhooks