Signalize API (1.9.0)

Download OpenAPI specification:Download

etracker GmbH: info@etracker.com URL: https://signalize.com

Signalize API

Create a PushMessage V3

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

Authorizations:

ApiKeyAuth

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

Payload

Content type

application/json

{"validUntil": 1597134207000,
"segmentFilter": {"segments": [{"name": "custom_segment_SIGNALIZE_INTEREST",
"operator": "CONTAINS",
"value": "Thema 1"
}
]
},
"webPush": {"webPushMessageTexts": [{"language": "de",
"standard": true,
"title": "Hello World!",
"message": "This is a test-message.",
"targetUrl": "https://www.signalize.com",
"icon": "https://s3.eu-central-1.amazonaws.com/signalize/474747/f44453ce-e19f-46de-a565-16df78b7167f.png",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/signalize/474747/f44453ce-e19f-46de-a565-16df78b7167f.png",
"actions": [{"action": "https://www.signalize.com/button-0",
"title": "Test Button"
}
]
}
]
}
}

Response samples

Content type

application/json

{"messageId": 42
}

Send a PushMessage V3 directly to a single client Deprecated

Deprecated: use /v3/subscriptions/pushmessages instead.
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:

ApiKeyAuth

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

Payload

Content type

application/json

{"validUntil": 1597134207000,
"webPush": {"webPushMessageTexts": [{"language": "de",
"standard": true,
"title": "Hello World!",
"message": "This is a test-message.",
"targetUrl": "https://www.signalize.com",
"icon": "https://s3.eu-central-1.amazonaws.com/signalize/474747/f44453ce-e19f-46de-a565-16df78b7167f.png",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/signalize/474747/f44453ce-e19f-46de-a565-16df78b7167f.png",
"actions": [{"action": "https://www.signalize.com/button-0",
"title": "Test Button"
}
]
}
]
}
}

Response samples

Content type

application/json

{"messageId": 42
}

Send a new message to single subscriptions

Creates a new instance of a PushMessage V3 with multi language and channel support.
The message is sent out directly to the given subscriptions.
Addressing can be done via client-IDs or external-IDs.

External-ID

Optional identifier that can be attached to a subscription when a subscriber visits your page.
This should be a value you already know (for example a CRM-ID) which never changes.

It can be set via a GET parameter called et_exid on your website (e.g.: www.example.com?et_exid=someId).
Or via a global JS-variable with the same name (e.g.: var et_exid="someID";).

Client-ID

If you don't want to provide an external-ID, a unique (but potentially changing) ID is also given by Signalize, called clientId.
This ID can only be obtained via JavaScript if the subscriber visits your page.

If Signalize is active 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:

ApiKeyAuth

Request Body schema: application/json

clientIds	Array of strings Optional list of client-IDs
externalIds	Array of strings Optional list of external-IDs
required	object (PushMessageV3Input)

Responses

Request samples

Payload

Content type

application/json

{"externalIds": ["12345",
"67890"
],
"message": {"validUntil": 1597134207000,
"webPush": {"webPushMessageTexts": [{"language": "de",
"standard": true,
"title": "Hello World!",
"message": "This is a test-message.",
"targetUrl": "https://www.signalize.com",
"icon": "https://s3.eu-central-1.amazonaws.com/signalize/474747/f44453ce-e19f-46de-a565-16df78b7167f.png",
"imageUrl": "https://s3.eu-central-1.amazonaws.com/signalize/474747/f44453ce-e19f-46de-a565-16df78b7167f.png",
"actions": [{"action": "https://www.signalize.com/button-0",
"title": "Test Button"
}
]
}
]
}
}
}

Response samples

Content type

application/json

{"messageId": 42
}

Send a template to single subscriptions

Sends an existing message / template to the given subscriptions.
Templates can be created beforehand in the UI, which will also display the ID.

Addressing is done via client-IDs or external-IDs.
For more information about obtaining subscription IDs, see /v3/subscriptions/pushmessages.

Authorizations:

ApiKeyAuth

Request Body schema: application/json

clientIds	Array of strings Optional list of client-IDs
externalIds	Array of strings Optional list of external-IDs

Responses

Request samples

Payload

Content type

application/json

{"externalIds": ["12345",
"67890"
]
}

Response samples

Content type

application/json

{"messageId": 42
}