Signalize API (1.9.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

Create a PushMessage V2 Deprecated

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.

Array of objects (MessageText)

an array of MessageText

object

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
42

Create a PushMessage V3

Creates a new instance of a PushMessage V3 with multi language and channel support.

Authorizations:
Request Body schema: application/json
object (Schedule)

Optional object for scheduling, if not set, the message will be sent immediately.

object (SegmentFilter)

Optional object to filter subscriber

status
string
Enum: "TEMPLATE" "ACTIVE"
validUntil
integer <int64>

Timestamp (in ms) after which the message will be deleted / not shown to a receiver anymore

object (PushMessageV3WebPush)

Data for a web/safari message

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "timestamp": "2019-09-26T09:23Z",
  • "status": 400,
  • "error": "Bad request",
  • "message": "Bad request",
  • "path": "/v3/pushmessages",
  • "errorCode": ""
}

Sends a PushMessage V3 directly to a single client

Creates a new instance of a PushMessage V3 with multi language and channel support. The message is sent out directly to the given client ID.

Client-ID

For this endpoint, you need to know the ID of a specific subscriber, called clientId.
This ID can only be obtained via JavaScript if the client visits your page.

If Signalize is activated and the client supports web-push, a global object called et_signalize will be available.
Since Signalize is loaded asynchronously, it might not be set before the whole page was loaded.

Once loaded, you can call et_signalize.getClientId() to receive the unique clientId.

Authorizations:
Request Body schema: application/json
object (Schedule)

Optional object for scheduling, if not set, the message will be sent immediately.

object (SegmentFilter)

Optional object to filter subscriber

status
string
Enum: "TEMPLATE" "ACTIVE"
validUntil
integer <int64>

Timestamp (in ms) after which the message will be deleted / not shown to a receiver anymore

object (PushMessageV3WebPush)

Data for a web/safari message

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "timestamp": "2019-09-26T09:23Z",
  • "status": 400,
  • "error": "Bad request",
  • "message": "Bad request",
  • "path": "/v3/subscriptions/{clientId}/pushmessages",
  • "errorCode": ""
}