Register a listener
The Eptura Engage API service can send notifications on various actions for room bookings, desk bookings, resources and visitors. To receive notifications from the Admin API, a listener service should be created that actions any notifications received from the Notification Pusher service.
List of Event type
| Event type | Event type |
|---|---|
| Meeting | 1 |
| Desk | 2 |
| MeetingExternal | 3 |
| IPPhone | 4 |
| MeetingProgression | 5 |
| DeskProgression | 6 |
| Resource | 7 |
| Visitor | 8 |
Queue Provider List
| Queue Provider | Name Value |
|---|---|
| NOTIFICATIONHUB.PUBLISHNOTIFICATIONPROVIDER | 2 |
| NOTIFICATIONHUB.AZUREQUEUEPROVIDER | 3 |
| NOTIFICATIONHUB.AZUREQUEUEFILTEREDPROVIDER | 4 |
Registering a listener
Endpoint used to register a listener in Notification Pusher. It requires a valid session token.
Method Type: POST
URL: https://[BASEURL]/[APIURLSUFFIX]/api/V1/listener
e.g. https://[BASEURL]/Condeco_Software_UK_Demo/api/V1/listener
The BASEURL is one of the following, depending on your subscription:
- Partners/Developers: developer-api.condecosoftware.com
- Customers (UAT and Prod): integrationportal.condecosoftware.com
Request Body
{
"secretkey": "string",
"eventTypes": [
0
],
"resourceIds": [
0
],
"
": "string",
"queueProvider": 0
}
Request Parameters
| Name | Description | Optional/ Required |
|---|---|---|
| secretKey | Application secret key | Required |
| eventType | List of an event type. Takes numerical values from the list given below | Required |
| resourceIds | List of valid room/desk Ids for filtered subscription only,required only for ‘NOTIFICATIONHUB.AZUREQUEUEFILTEREDPROVIDER’ provider | Optional |
| notificationUrl | Notification listener URL | Required |
| queueProvider | Requires valid provider. If not provided it will take default provide | Optional |
Response
Unregister Listener in Notification Pusher
Endpoint to delete a listener in Notification Pusher
Method Type: DELETE
URL: https://[BASEURL]/[APIURLSUFFIX]/api/V1/listener
e.g. https://[BASEURL}/Condeco_Software_UK_Demo/api/V1/listener
The BASEURL is one of the following, depending on your subscription:
- Partners/Developers: developer-api.condecosoftware.com
- Customers (UAT and Prod): integrationportal.condecosoftware.com
Request Body
{
"listenerId": 0,
"eventType": 0,
"notificationUrl": "string",
"queueProvider": 0
}
Response
GET Registered Listeners by URL
Endpoint that is used to get the list of the subscribed listeners.
Method Type: GET
URL: https://[BASEURL]/[APIURLSUFFIX]/api/V1/listener/notificationUrl=[NOTIFICATIONURL]
e.g. https://[BASEURL]/developer_sde/api/V1/listener?notificationURL=https://test.co.uk
The BASEURL is one of the following, depending on your subscription:
- Partners/Developers: developer-api.condecosoftware.com
- Customers (UAT and Prod): integrationportal.condecosoftware.com
Response
