Signalize API (1.5.0)

Download OpenAPI specification:Download

Signalize API

Authentication

ApiKeyAuth

API Keys security scheme. A key can be created in the signalize application in the account and privacy settings.

Security scheme type: API Key
Header parameter name: X-API-Key

beta

version 2

Create a PushMessage Deprecated

Creates a new instance of a PushMessage.

Authorizations:
Request Body schema: application/json

A new PushMessage to be created.

title
required
string

title for the push message

message
required
string

content of the push message

targetUrl
required
string

url to be taken directly to where the user can get more information about the notification

imageUrl
string

url for an image which match the context of the notification so users can identify it without reading, e.g. https://example.com/image.png" or base64 encoded

icon
string

a small image which match the context of the notification so users can identify it without reading as url https://example.com/image.png" or base64 encoded

Responses

200

Successful response - a new PushMessage is created.

400

Bad request - no PushMessage is created.

401

Unauthorized - Authentication is required, API key is missing or invalid.

429

Too many requests - too many requests in a given amount of time.

500

Internal Server Error - An unexpected condition has encountered.

504

Time out - Did not receive a timely response from the upstream server.

post /v1/pushmessages

Signalize API (Production)

https://api.signalize.com/v1/pushmessages

Request samples

Content type
application/json
Copy
Expand all Collapse all

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "timestamp": "2019-09-26T09:23Z",
  • "status": 200,
  • "error": "",
  • "errorCode": "",
  • "message": 42
}

Create a PushMessage V2

Creates a new instance of a PushMessage V2 with multi language support.

Authorizations:
Request Body schema: application/json

A new PushMessage V2 to be created.

pushMessageTexts
Array of objects (MessageText)

an array of MessageText

segmentFilter
object

Responses

200

Successful response - a new PushMessage is created.

400

Bad request - no PushMessage is created.

401

Unauthorized - Authentication is required, API key is missing or invalid.

429

Too many requests - too many requests in a given amount of time.

500

Internal Server Error - An unexpected condition has encountered.

504

Time out - Did not receive a timely response from the upstream server.

post /v2/pushmessages

Signalize API (Production)

https://api.signalize.com/v2/pushmessages

Request samples

Content type
application/json
Copy
Expand all Collapse all
{}

Response samples

Content type
application/json
Copy
Expand all Collapse all
42