Browse docs +

cURL / Shell

Connect a script or terminal with one command.

Set BREEZE_SERVER to https://push.breezelabs.dev and store your key as the environment secret BREEZE_WEBHOOK_KEY.

cURL / Bash
curl --silent --show-error --fail-with-body \
  --connect-timeout 5 --max-time 20 \
  "${BREEZE_SERVER}/v1/send" \
  -H "Authorization: Bearer ${BREEZE_WEBHOOK_KEY}" \
  -H 'Content-Type: application/json' \
  --data-binary '{"title":"Backup complete","message":"The backup job has finished","thread_id":"backups"}'

Keep set -x disabled and do not print request headers to logs. These examples omit automatic retry options: a timeout may occur after Apple or Google has accepted the request, so immediately resending it can produce duplicate notifications.

Delivery results and retry guidance