notifications

POST /v1/me/push-devices/{device_id}/test

Send a real test alert to this phone now.

All notifications endpoints

All developer docs →

Zinn®, our Viking, hammering at his anvil beside an API endpoint sending events to several listeners.

Authentication

Send an API key as a bearer token. This endpoint checks no specific permission, so any key for your organisation can call it.

Where your organisation id goes

This endpoint takes org_id as a query parameter. Leave it out and the call covers your whole tenancy subtree; send it to narrow the call to one organisation.

Your organisation id is on the API keys screen in your dashboard, beside the key itself. It is the same id in every call you make.

Try it

Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.

curl -X POST https://api.zinndigital.com/v1/me/push-devices/{device_id}/test \
  -H "Authorization: Bearer zdk_live_…"

Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console

Details

Ignores quiet hours (the customer asked for it). A failure is returned as sent=false with its class, not as an error status; if the push service says the app is gone from the phone, the phone is removed (removed=true).

Parameters

NameTypeRequiredWhat it is
device_id (path)stringYes—
org_id (query)stringNo—

Response

NameTypeRequiredWhat it is
sentbooleanYes—
error_codestringYes—
removedbooleanYes—

Errors this endpoint can return

401 · 403 · 404