Webhooks and push
CLI commands to manage webhook endpoints and deliveries, and to send push notifications.
These commands manage the webhooks Voidhash sends to your backend and the push notifications it sends to people's devices. Studio covers them under Settings → Webhooks, Settings → Notifications and Activity → Sent notifications.
Webhooks
| Command | What it does | Key flags |
|---|---|---|
webhook list | Webhooks and whether they deliver. | |
webhook view [webhook] | URL, events, health and latest deliveries. | |
webhook create | Creates a webhook and prints its signing secret, shown only once. | --name, --url, --event (repeat), --description, --environment production|test |
webhook edit [webhook] | Changes its name, URL, events, description or environment. | Same as create |
webhook enable [webhook] | Turns it on again, including one Voidhash stopped after repeated failures. | |
webhook disable [webhook] | Stops sending to it without deleting it. Asks first. | |
webhook delete [webhook] | Deletes it and its delivery history. Asks first. | |
webhook rotate [webhook] | Replaces the signing secret; the old one stops working at once. Asks first. | |
webhook test [webhook] | Sends a signed test event. Exits 1 when it isn't accepted. | |
webhook deliveries [webhook] | Deliveries, newest first, with how the endpoint answered. | --failed, --limit (default 20, at most 100) |
webhook delivery <delivery> | One delivery with every attempt. | |
webhook retry [delivery…] | Sends failed deliveries again. Exits 1 unless all are delivered. |
--event takes an event type such as purchase.completed, a group such as subscription.*, or
all. A production webhook receives production purchase events; a test webhook receives store
sandbox and test purchase events. Person events reach both. See Webhook delivery and
Webhook events.
Push notifications
| Command | What it does | Key flags |
|---|---|---|
push send | Sends a notification to people's devices. Shows who it reaches and asks first. | --to (repeat), --title, --body, --data key=value, --dry-run |
push list | The latest notifications with delivered, failed and skipped counts. | --limit (at most 100) |
push deliveries [push] | How a notification reached each device. | --failed |
push config list | The push services the project sends through. | |
push config set apns | Sets up and turns on APNs. | --team-id, --key-id, --key-file <.p8>, --bundle-id, --environment production|sandbox |
push config set fcm | Sets up and turns on FCM. | --service-account-file <.json> |
push config enable [service] | Turns apns or fcm back on with its saved credentials. | |
push config disable [service] | Stops sending through it, keeping its credentials. | |
push config delete [service] | Deletes its credentials. Asks first. |
APNs --environment is production (default) for App Store and TestFlight builds, and sandbox
for builds from Xcode.
Example
voidhash webhook create --name "Orders backend" --url https://example.com/webhooks --event subscription.* --environment test
voidhash push send --to user_123 --title "Your trial ends tomorrow" --body "Renew to keep Pro." --dry-runNext steps
- Webhook delivery: endpoints, retries and the payload.
- Webhook events: every event type.
- Push notifications: set up APNs and FCM.
Something wrong or missing on this page? Tell us by email or on Discord.