🔔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

POSThttps://push.techulus.com/api/v1/notify

Authorization

api_key_header

Body

application/json

Notification

title*string

Notification title

body*string

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)

imagestring

Notification image (URL)

timeSensitiveboolean

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

Response

200400401500

Successful operation

Body

application/json

success*boolean

messagestring

responsesarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://push.techulus.com/api/v1/notify', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "body": "text"
    }),
});
const data = await response.json();

Response

200400401

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

Suitable for webhooks

GEThttps://push.techulus.com/api/v1/notify/{apiKey}

Path parameters

apiKey*string

Account / Team API Key

Query parameters

Response

200400401500

Successful operation

Body

application/json

success*boolean

messagestring

responsesarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://push.techulus.com/api/v1/notify/{apiKey}?title=text&body=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

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

POSThttps://push.techulus.com/api/v1/notify/{apiKey}

Path parameters

apiKey*string

Account / Team API Key

Body

application/json

Notification

title*string

Notification title

body*string

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)

imagestring

Notification image (URL)

timeSensitiveboolean

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

Response

200400401500

Successful operation

Body

application/json

success*boolean

messagestring

responsesarray of object

Request

JavaScriptCurlPython

const response = await fetch('https://push.techulus.com/api/v1/notify/{apiKey}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "body": "text"
    }),
});
const data = await response.json();

Response

200400401

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

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

Async Request, recommened for teams

POSThttps://push.techulus.com/api/v1/notify-async

Authorization

api_key_header

Body

application/json

Notification

title*string

Notification title

body*string

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)

imagestring

Notification image (URL)

timeSensitiveboolean

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

Response

200400401500

Successful operation

Body

application/json

success*boolean

message*string

Request

JavaScriptCurlPython

const response = await fetch('https://push.techulus.com/api/v1/notify-async', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "title": "text",
      "body": "text"
    }),
});
const data = await response.json();

Response

200400401

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

Sample Request body

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