Close

Email & Notifications API

Once users are registered to receive emails and/or push notifications, content can be sent with this API for testing purposes. The delivery type (email or push notification) will depend on the type of content being used.

Delivery: get

Delivers the content specified to the provided user.

Request Definition

The API URL is assigned per organization. We use “{orgname}” as an example, when testing use your organization’s assigned subdomain name defined in the Omniata panel.

GET https://{orgname}.panel.omniata.com/deliver

Parameters

Use the following parameters to deliver notifications:

Name Example Description
api_key
mandatory
11111111 Identifies multiple aspects of the events such as the organization and environment.
uid
mandatory
10000001A Uniquely identifies a user within the organization’s UID domain.
content_id
mandatory
37 Unique identifier of the content to deliver to the user.

Response

If successful the returned answer is a JSON structure with the status of the request.

Example request:

$ curl "http://{orgname}.panel.omniata.com/deliver?api_key=11111111&uid=10000001A&content_id=37"

Example response:

{"status":"Success"}

This article was last updated on March 30, 2017 15:04. If you didn't find your answer here, search for another article or contact our support to get in touch.