🔔Notify all devices or teams

APIs to send push notification to all devices connected to your account or or a team.

The targeting is based on which API key you specify in the request:

• If you use you account API key the notification will be send to all devices in your account.

• If you specify a team API key then the notification will be send to all devices for every member in the team.

Your API Key is required for making any requests using our API, you can find it inside the console integrations page (https://push.techulus.com/console/integrations) or Account tab in mobile app. Team API keys can be found in the team details screen.

The authentication header (API Key) to be specified in the request is x-api-key

There are several ways you can make this request:

Sync Request

post

/notify

Authorizations

Body

titlestringrequired

Notification title

bodystringrequired

Notification Body

soundstring

Notification sound, valid options are default, arcade, correct, fail, harp, reveal, bubble, doorbell, flute, money, scifi, clear, elevator, guitar, pop.

channelstring · default: feed

Notification channel, alphanumerical string and hyphens only.

linkstring

Notification link (URL)

imagestring

Notification image (URL)

timeSensitiveboolean

Time sensitive notifications will be delivered immediately, even if the device is in do not disturb mode. (iOS only)

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://push.techulus.com/api/v1/notify' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"title":"text","body":"text","channel":"feed","timeSensitive":false}'

200

400

401

500

200

{
  "success": true,
  "message": "text",
  "responses": [
    {
      "success": true,
      "message": "text"
    }
  ]
}

Successful operation

Suitable for webhooks

get

/notify/{apiKey}

Path parameters

apiKeystringrequired

Account / Team API Key

Query parameters

titlestringrequired

Notification title

bodystringrequired

Notification Body

soundstring

Notification sound, valid options are default, arcade, correct, fail, harp, reveal, bubble, doorbell, flute, money, scifi, clear, elevator, guitar, pop.

channelstring

Notification channel, alphanumerical string and hyphens only.

linkstring

Notification link URL (URL Encoded)

imagestring

Notification image URL (URL Encoded)

timeSensitiveboolean

Time sensitive notifications will be delivered immediately, even if the device is in do not disturb mode. (iOS only)

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://push.techulus.com/api/v1/notify/{apiKey}?title=text&body=text'

200

400

401

500

200

{
  "success": true,
  "message": "text",
  "responses": [
    {
      "success": true,
      "message": "text"
    }
  ]
}

Successful operation

post

/notify/{apiKey}

Path parameters

apiKeystringrequired

Account / Team API Key

Body

titlestringrequired

Notification title

bodystringrequired

Notification Body

soundstring

Notification sound, valid options are default, arcade, correct, fail, harp, reveal, bubble, doorbell, flute, money, scifi, clear, elevator, guitar, pop.

channelstring · default: feed

Notification channel, alphanumerical string and hyphens only.

linkstring

Notification link (URL)

imagestring

Notification image (URL)

timeSensitiveboolean

Time sensitive notifications will be delivered immediately, even if the device is in do not disturb mode. (iOS only)

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://push.techulus.com/api/v1/notify/{apiKey}' \
  --header 'Content-Type: application/json' \
  --data '{"title":"text","body":"text","channel":"feed","timeSensitive":false}'

200

400

401

500

200

{
  "success": true,
  "message": "text",
  "responses": [
    {
      "success": true,
      "message": "text"
    }
  ]
}

Successful operation

We recommend the asynchronous API if you've more than 10 devices:

Async Request, recommened for teams

post

/notify-async

Authorizations

Body

titlestringrequired

Notification title

bodystringrequired

Notification Body

soundstring

Notification sound, valid options are default, arcade, correct, fail, harp, reveal, bubble, doorbell, flute, money, scifi, clear, elevator, guitar, pop.

channelstring · default: feed

Notification channel, alphanumerical string and hyphens only.

linkstring

Notification link (URL)

imagestring

Notification image (URL)

timeSensitiveboolean

Time sensitive notifications will be delivered immediately, even if the device is in do not disturb mode. (iOS only)

Responses

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://push.techulus.com/api/v1/notify-async' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{"title":"text","body":"text","channel":"feed","timeSensitive":false}'

200

400

401

500

200

{
  "success": true,
  "message": "text"
}

Successful operation

Sample Request body

{
    "title": "Welcome to Push by Techulus",
    "body": "This is your first notification"
}