Custom API Integration Guide

Use our REST API to send custom notifications from any application, service, or platform using tools like Postman.

Prerequisites

Notifico app installed on your device
Postman app installed on your PC (or any HTTP client)
Basic understanding of REST APIs

Setup Steps

Create a Custom Topic

In the Notifico app, go to Create Topic and select Topic Type as 'Custom'. This will give you a flexible endpoint for sending any type of notification.

Copy API Credentials

Copy both the API URL and API Token from your topic. You'll use the URL as the endpoint and the token for authorization.

Open Postman

Download and install Postman if you haven't already. Click 'New' and select 'HTTP' to create a new request.

Configure the Request

Set the request method to POST. Paste your API URL in the address bar. Go to Body tab, select 'raw', and choose 'JSON' format.

Postman configuration with POST method and body settings

Sample Request Body

Use this JSON structure as a template for your notification payload. You can include any combination of media types.

json

{
    "title": "Test Custom Topic",
    "description": "Includes multimedia examples from various sources.",
    "audio": [
        {
            "url": "https://github.com/rafaelreis-hotmart/Audio-Sample-files/raw/master/sample.mp3",
            "name": "SampleFile.mp3"
        },
        {
            "url": "https://github.com/rafaelreis-hotmart/Audio-Sample-files/raw/master/sample.ogg",
            "name": "MyPodcast69.ogg"
        }
    ],
    "videosUrl": [
        "https://videos.pexels.com/video-files/34686551/14702188_1440_2560_30fps.mp4",
        "https://videos.pexels.com/video-files/37764806/16018539_1080_1920_60fps.mp4"
    ],
    "imagesUrl": [
        "https://images.unsplash.com/photo-1501630834273-4b5604d2ee31",
        "https://images.unsplash.com/photo-1504384308090-c894fdcc538d"
    ],
    "files": [
        {
            "url": "https://www.w3.org/WAI/ER/tests/xhtml/testfiles/resources/pdf/dummy.pdf",
            "name": "Test.pdf"
        }
    ],
    "htmlUrl": "https://www.weather.gov/safety/flood"
}

Add Authorization

Go to the Authorization tab in Postman. Select 'Bearer Token' from the Type dropdown and paste your API Token in the token field.

Postman authorization tab with Bearer Token

Send the Request

Click the 'Send' button. If successful, you'll receive a '201 Created' status response. If you get any other status, check your credentials and payload format.

API Reference

Field	Type	Description
title	string	The notification title
description	string	The notification body text
audio	array	Array of audio files with url and name
videosUrl	array	Array of video URLs
imagesUrl	array	Array of image URLs
files	array	Array of files with url and name
htmlUrl	string	URL to an HTML page to embed

💡 Pro Tips

• All fields except title are optional - send only what you need
• Use publicly accessible URLs for media files
• A 201 status code confirms successful delivery
• Check Content-Type header is set to application/json

WooCommerce Guide Back to Introduction