Skip to main content
Six areas covering everything under the organization: webhooks, alerts, keys, team, audit, and org.

Webhooks

Reads need webhooks:read, writes webhooks:write, deletes webhooks:delete, and the test send webhooks:test.

grantiva console webhooks list

grantiva console webhooks events

List the event types a webhook can subscribe to.
Run this before create — event names are validated against this list before the request is sent.

grantiva console webhooks create

Create a webhook endpoint.
The URL must be https. The signing secret is printed once — capture it now.

grantiva console webhooks update

Change a webhook’s events or description.
--event replaces the subscribed events rather than adding to them.

grantiva console webhooks enable / disable

Resume or pause deliveries without deleting the endpoint.

grantiva console webhooks test

Send a test event and report the endpoint’s response.
Prints the outcome and latency, and exits 1 when the endpoint fails — so it works as a deploy gate. Needs webhooks:test.

grantiva console webhooks deliveries

List recent deliveries for a webhook.

grantiva console webhooks retry

Retry a failed delivery.

grantiva console webhooks delete

Delete a webhook endpoint and its delivery history.

Alerts

Three groups: risk alert rules, the attestation failure-rate alert, and notification preferences.

Risk alert rules

Rules fire a webhook when a device’s risk score crosses a threshold. Available on the Business plan and up. Reads need alerts:read, writes alerts:write.
deliveries lists recent deliveries across all rules.

Failure-rate alert

Fires when the attestation failure rate crosses a threshold.
get and history need alerts:read; set needs org:write.

Notification preferences

Which events email the org admin.
Toggles: newFeatureRequest, featureVoteThreshold, featureStatusChange, newSupportTicket, ticketAdminReply, ticketResolved, ticketUserReply, flagToggle, teamInvite, usageAlert. featureVoteThresholdCount=<n> takes a number rather than on/off. get needs org:read; set needs org:write.

API keys

list shows key prefixes only. create prints the raw key once. rotate issues a replacement holding the same scopes. A key can only create keys with scopes it holds itself; the server’s refusal is shown verbatim. list needs keys:read; create, rotate, and revoke need keys:write.
The scope names are listed in the console overview.

Team

--role defaults to member. remove takes the membership ID from team members; admins and the owner cannot be removed with an API key. members and invites need org:read. The mutations need admin:team.

Audit log

Newest first. Needs admin:audit.

Organization

usage reports Monthly Active Devices against the plan limit. billing show reports the plan, usage, and current period — it is read-only; manage billing in the dashboard. Renaming the org also updates its slug. settings get and usage need org:read; set-name needs org:write; billing show needs admin:billing.
The admin:team, admin:audit, and admin:billing scopes are Enterprise-only on an API key.

Next steps

  • Console overview — auth, scopes, and shared conventions
  • Webhooks — payload shapes and signature verification
  • Billing — plans and what counts as a Monthly Active Device