This API is an add-on feature of Notificare. It can be used by other systems to get notified about almost everything in your application. From device registration, user data changes, geo-triggers and notifications sent in real-time. Build complex integrations of Notificare that react to users behaviour and other app events using your own infrastructure. Please contact sales@notifica.re to find out the pricing for your current plan.
Configure Service
Before you can use this API, please make sure you read and configure your app as described here.
After successful configuration and activation of this API, you will start receiving Live API events as described below. Note that any change to the Target Endpoint will reset the public and private keys and therefore you will need to repeat the whole process again.
Example Projects
For a hands-on approach, we've created some example projects to help you understand how you would set up your server and handle all the events streamed by this API. Please checkout these examples:
Below you will find a list of all the events available for you. Live API events are based in Notificare namespaces. The data received will be always directly connected to the type of event and should be handled accordingly.
Events
Sent whenever a public event is created. Only events over notifications received and opened, regions and beacons visits, passes added, removed or redeemed, as well as your own custom events are sent to this API.
Property
Example
Description
Type
service
My Service
The human readable string that describes this Live API service
The numeric value corresponding to milliseconds since Unix epoch
Number
Possible Types
Type
re.notifica.event.sms.Unsubscribe
re.notifica.event.sms.Nondeliverable
Payload
Key
Description
subscriptionId
The subscription identifier (phone number)
deviceID
The device identifier which originated the event
notification
The identifier of the message from which the event originated (optional)
LIVE API hooks
Hooks will be triggered whenever a (shared access) Dashboard user or an API client performs some action in your app in Notificare.
Live API hooks are also based in Notificare namespaces.
Below you will find a list of all the hooks available for you,
The data received will be always directly connected to the type of hook and should be handled accordingly.
Export
Sent whenever an export job changes status.
Property
Example
Description
Type
service
My Service
The human readable string that describes this Live API service
String
type
re.notifica.hook.export.Exported
The jobs Notificare's namespace
String
data
{"id": "54ac46e8...2e39ca0"}
The data relative to this Live API event
Object
timestamp
1421656451382
The numeric value corresponding to milliseconds since Unix epoch
Number
Possible Types
Type
re.notifica.hook.export.Exported
re.notifica.hook.export.Failed
Import
Sent whenever an import job changes status.
Property
Example
Description
Type
service
My Service
The human readable string that describes this Live API service
String
type
re.notifica.hook.import.Imported
The jobs Notificare's namespace
String
data
{"id": "54ac46e8...2e39ca0"}
The data relative to this Live API event
Object
timestamp
1421656451382
The numeric value corresponding to milliseconds since Unix epoch
Number
Possible Types
Type
re.notifica.hook.import.Imported
re.notifica.hook.import.Verified
re.notifica.hook.import.Failed
Payload
Key
Description
id
The Id of the import job executed
Notification
Sent whenever a notification is created or updated. Only non-triggered and non-draft notifications will execute the hook.
Property
Example
Description
Type
service
My Service
The human readable string that describes this Live API service
String
type
re.notifica.hook.notification.Created
The notification hooks Notificare's namespace
String
data
{"id": "54ac46e8...2e39ca0"}
The data relative to this Live API event
Object
timestamp
1421656451382
The numeric value corresponding to milliseconds since Unix epoch
Number
Possible Types
Type
re.notifica.hook.notification.Created
re.notifica.hook.notification.Updated
re.notifica.hook.notification.Scheduled
Payload
Key
Description
id
The Id of the notification
Expected Response
Your server should reply in a certain manner whenever you handle the verification or the payload of events. This is crucial for this API to be able to either activate the service, discard handled events or retry events whenever your server cannot handle them.
Verification
Before you can start receiving any events, you must implement a verification endpoint. This is the first step to activate the service. Only after a successful verification this LIVE API will start sending all the events that occur in your application. For that make sure you respond with a 200 status code whenever you attempt to validate the service. The response also should include a digest of the public key as the response payload body.
Payload Handling
Once the service is active you will start receiving all events that happen in your application. To signal the LIVE API that you've handle the event and it should be discarded, reply with a 200s code range. In case your server is busy, not accessible or simply you when cannot handle the event, reply with a 400s or 500s code range and our API will keep retrying any event until it gets a successful response from your server.
