PushAPI integration quickstart
Send your first Push notification with a simple HTTPS request.
Before you start, install Push by Techulus on an iOS or Android device, sign in to your account, and allow notifications. This guide uses your account API key to notify every device in that account.
You will need a terminal with cURL and a Bash-compatible shell for the examples below.
Get your API key
Copy your account API key from the console integrations page or the Account tab in the mobile app.
Replace YOUR_API_KEY below and set the key in your terminal session:
export PUSH_API_KEY='YOUR_API_KEY'Treat your API key as a secret. Keep it out of source control, browser-side code, and shared logs. In your application, store it in a server-side environment variable or secret manager.
Team API keys target the team's devices instead. See authentication and targeting before using a team key.
Send your first notification
Send a POST request to https://push.techulus.com/api/v1/notify. Put your API key in the x-api-key header and send a JSON body containing title and body.
Run this command in the same terminal session. It sends a real notification to all devices in your account; --include displays the HTTP status and response headers alongside the JSON response.
curl --include --request POST 'https://push.techulus.com/api/v1/notify' \
--header "x-api-key: $PUSH_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"title":"Hello from the API","body":"Your first Push notification."}'Only title and body are required. See the POST /notify reference for optional fields and examples in other programming languages.
Check the result
Inspect the response's success flag and any per-device responses, then confirm that the notification arrived on your device.
| HTTP status | What to check |
|---|---|
200 | The request was processed. Check the returned delivery results and your device. |
400 | Check that the body is valid JSON with title and body, and that Content-Type is application/json. |
401 | Check that x-api-key contains your API key, not the placeholder. |
500 | A server error occurred. If it persists, contact support. |
If no notification appears, make sure the device is signed in to the account whose key you used and that notifications are allowed for Push. See the response schemas for the documented response fields.
Once the request works, make the same authenticated HTTPS request from your application's backend. For teams or more than 10 devices, use asynchronous delivery. To target a specific device group, use the device-group endpoint.