🔔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

Authorizations

Body

titlestringRequired

Notification title

bodystringRequired

Notification Body

soundstringOptional

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

channelstringOptional

Notification channel, alphanumerical string and hyphens only.

Default: feed

linkstringOptional

Notification link (URL)

imagestringOptional

Notification image (URL)

timeSensitivebooleanOptional

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

Default: false

Responses

200

Successful operation

application/json

400

Invalid input

application/json

401

Invalid authentication

application/json

500

Server Error

post

HTTPcURLJavaScriptPython

POST /api/v1/notify HTTP/1.1
Host: push.techulus.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "title": "text",
  "body": "text",
  "sound": "text",
  "channel": "feed",
  "link": "text",
  "image": "text",
  "timeSensitive": false
}

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

Suitable for webhooks

get

Path parameters

apiKeystringRequired

Account / Team API Key

Query parameters

titlestringRequired

Notification title

bodystringRequired

Notification Body

soundstringOptional

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

channelstringOptional

Notification channel, alphanumerical string and hyphens only.

linkstringOptional

Notification link URL (URL Encoded)

imagestringOptional

Notification image URL (URL Encoded)

timeSensitivebooleanOptional

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

Responses

200

Successful operation

application/json

400

Invalid input

application/json

401

Invalid authentication

application/json

500

Server Error

get

HTTPcURLJavaScriptPython

GET /api/v1/notify/{apiKey} HTTP/1.1
Host: push.techulus.com
Accept: */*

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

post

Path parameters

apiKeystringRequired

Account / Team API Key

Body

titlestringRequired

Notification title

bodystringRequired

Notification Body

soundstringOptional

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

channelstringOptional

Notification channel, alphanumerical string and hyphens only.

Default: feed

linkstringOptional

Notification link (URL)

imagestringOptional

Notification image (URL)

timeSensitivebooleanOptional

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

Default: false

Responses

200

Successful operation

application/json

400

Invalid input

application/json

401

Invalid authentication

application/json

500

Server Error

post

HTTPcURLJavaScriptPython

POST /api/v1/notify/{apiKey} HTTP/1.1
Host: push.techulus.com
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "title": "text",
  "body": "text",
  "sound": "text",
  "channel": "feed",
  "link": "text",
  "image": "text",
  "timeSensitive": false
}

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

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

Async Request, recommened for teams

post

Authorizations

Body

titlestringRequired

Notification title

bodystringRequired

Notification Body

soundstringOptional

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

channelstringOptional

Notification channel, alphanumerical string and hyphens only.

Default: feed

linkstringOptional

Notification link (URL)

imagestringOptional

Notification image (URL)

timeSensitivebooleanOptional

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

Default: false

Responses

200

Successful operation

application/json

400

Invalid input

application/json

401

Invalid authentication

application/json

500

Server Error

post

HTTPcURLJavaScriptPython

POST /api/v1/notify-async HTTP/1.1
Host: push.techulus.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "title": "text",
  "body": "text",
  "sound": "text",
  "channel": "feed",
  "link": "text",
  "image": "text",
  "timeSensitive": false
}

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

Sample Request body

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