Scribd
Upload
2 views

Push API

The POST Push API allows sending push notifications to specified users via a secure HTTPS connection using REST. Required parameters include UserId, UserEmail, UserExternalId, Title, Body, CompanyId, and IntegrationKey, with optional parameters for sound and expiry. The API supports both JSON and XML formats for requests, with XML requiring a specific namespace declaration.

Uploaded by

avengerthor52
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
2 views

Push API

The POST Push API allows sending push notifications to specified users via a secure HTTPS connection using REST. Required parameters include UserId, UserEmail, UserExternalId, Title, Body, CompanyId, and IntegrationKey, with optional parameters for sound and expiry. The API supports both JSON and XML formats for requests, with XML requiring a specific namespace declaration.

Uploaded by

avengerthor52
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

7/15/24, 6:14 PM

POST Push API


TABLE OF CONTENTS
Parameters
Example
ADDITIONAL INFO
API Explorer
General Information

This request method allows you to send a push notification to a specified user.

This API is available via SSL-secured HTTPS connection on the Cloud using the REST POST verb.
The format query string parameter controls the desired response format. Specify either XML or JSON.

/api/v2/push?format=xml/json

You may use either JSON or XML formats in your POST submission.
You indicate this by setting the ContentType HTTP header as "application/json" or "application/xml".
If no ContentType is specified, XML format is assumed.

All XML formatted requests must specify the following XML namespace in the data source root element:
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"

Parameters
The POST verb allows you to send a Push notification to a specified user.
The required and optional parameters for a POST call to the Push API are outlined below.

Name Type Description Required


UserId String Specify the target user via their API identifier. ✓*

UserEmail String Specify the target user via their email address. ✓*

UserExternalId String Specify the target user via their external identifier. ✓*

Title String A short message title. ✓

Body String A short message body. ✓


Sound Boolean Play a sound on the device when notification is received.
ExpirySecs Integer Removes message display on device after the given period.
Your unique Company ID is found on the Organization
CompanyId Integer ✓
Setup page of the secure website.
Your unique Integration Key is found on the Organization
IntegrationKey String ✓
Setup page of the secure website.

1/2
7/15/24, 6:14 PM

✓* - At least one user identifier needs to be specified, either UserId, UserEmail or UserExternalId

Example
Given that the API is REST-based, you can access the API directly via your web browser to test or by using the Postman
API Platform.

Request URL
https://secure.formsonfire.com/apiexplorer#!/push/postv2push

Request Body
{
"UserId": "",
"UserEmail": "",
"UserExternalId": "",
"Title": "",
"Body": "",
"Sound": false,
"ExpirySecs": 0,
"CompanyId": 0,
"IntegrationKey": ""
}

2/2

You might also like