Webhook¶
You can notify your own system of an incident by using the webhook action.
Sending data¶
Choose an HTTP method to be notified. We prefer POST, but other settings are also possible. If you actually want to receive the incident data, you must choose POST, PUT, DELETE or PATCH.
- Endpoint: The url on which Fireplug can send a message.
- Format: xml or json
- Method: POST, PUT, DELETE or PATCH.
{
"type": "DispatchIncident",
"id": 11431,
"account": 1,
"closedAt": "2023-12-06T14:29:21.976",
"location": {
"street": "Martelarenstraat",
"houseNumber": "141",
"longitude": 5.1026599,
"latitude": 51.1849892,
"city": "Mol",
"subCity": "",
"zipCode": "2400"
},
"date": "2023-12-06",
"time": "14:21:37.199",
"code": "6250501",
"description": "N05 => HOOFDPIJN",
"remarks": "",
"createdAt": "2023-12-06T14:21:37.226",
"uniqueIdentifier": "FIREPLUG-3ab4d277-e731-4cef-a814-3da45e1b36f2",
"priority": "PRIO_1",
"creator": null,
"customProperties": {},
"scenario": {
"id": 5052,
"language": null,
"country": null,
"code": "6250501",
"accountId": null,
"description": "N05 => HOOFDPIJN",
"usedBy": "MEDIC_CODES",
"isMedical": true,
"isDeleted": false,
"translation": {
"nl": "P025 - HOOFDPIJN",
"fr": "P025 - CÉPHALÉE"
}
},
"avlcode": null,
"callername": "Koen",
"callerRef": null,
"numCasualties": null,
"phoneNo": "+32 xxx xxxx", // a genuine phone number would be here
"servicename": null,
"resourcecode": null,
"resourcename": null,
"seqno": null,
"hc": "Dispatch",
"sectorCode": null,
"services": [
{
"servicetype": "MED",
"servicename": "WEETIKVEEL",
"resourcetype": "AMB",
"resourcename": "MG-MOL-1",
"hospitalname": null,
"friendlyName": "Mug Mol"
}
],
"dispatchProfiles": [229],
"callerCompanyNumber": null,
"active": false,
"latestAdditionalFields": []
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dispatchIncident>
<account>1</account>
<closedAt/>
<code>6250501</code>
<createdAt/>
<date/>
<description>N05 => HOOFDPIJN</description>
<id>11431</id>
<latestAdditionalFields>
<data/>
<id>11435</id>
<key>ROUTE</key>
<timestamp/>
</latestAdditionalFields>
<latestAdditionalFields>
<data/>
<id>11436</id>
<key>WEATHER</key>
<timestamp/>
</latestAdditionalFields>
<location>
<city>Mol</city>
<houseNumber>141</houseNumber>
<latitude>51.1849892</latitude>
<longitude>5.1026599</longitude>
<street>Martelarenstraat</street>
<subCity></subCity>
<zipCode>2400</zipCode>
</location>
<priority>PRIO_1</priority>
<remarks></remarks>
<scenario>
<id>5052</id>
<code>6250501</code>
<description>N05 => HOOFDPIJN</description>
<usedBy>MEDIC_CODES</usedBy>
<isMedical>true</isMedical>
<isDeleted>false</isDeleted>
</scenario>
<time/>
<uniqueIdentifier>FIREPLUG-3ab4d277-e731-4cef-a814-3da45e1b36f2</uniqueIdentifier>
<callername>Koen</callername>
<hc>Dispatch</hc>
<phoneNo>+32</phoneNo>
<services>
<friendlyName>mugpelt</friendlyName>
<resourcename>mugpelt</resourcename>
<resourcetype>AMB</resourcetype>
<servicename>Rand</servicename>
<servicetype>MED</servicetype>
</services>
<dispatchProfiles>229</dispatchProfiles>
</dispatchIncident>
{
"type": "EmcasIncident", // EmcasIncident, DispatchIncident or NC112Incident
"id": 11394, // id of the incident
"account": 1, // id of your account
"closedAt": "2023-11-22T17:20:29.315", // timestamp to close the incident
"location": {},
"date": "2023-11-22", // datepart
"time": "14:20:29.299", // timepart
"code": "636288d09c1541b6ef02d44c", // incidentCode
"description": "Een groot vuur bla bla - ZEER SPECIFIEK",
"remarks":"",
"createdAt": "2023-11-22T14:20:29.317",
"uniqueIdentifier": "2023-11-22 14:20:29.299466",
"priority": "PRIO_1", // PRIO_1, PRIO_2 or PRIO_3
"creator": "EmCaS", // context that created the incident
"rawData":"",
"customProperties":{}, // if you have defined custom properties, they would apear here
"scenario": {}, // the description of the incident
"info": [],
"active": false,
"latestAdditionalFields": [],
}
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<emcasIncident>
<account>1</account>
<closedAt/>
<code>636288d09c1541b6ef02d44c</code>
<createdAt/>
<creator>EmCaS</creator>
<date/>
<description>Een groot vuur - ZEER SPECIFIEK</description>
<id>11394</id>
<latestAdditionalFields>
<data/>
<id>11413</id>
<key>ROUTE</key>
<timestamp/>
</latestAdditionalFields>
<latestAdditionalFields>
<data/>
<id>11395</id>
<key>EMCAS</key>
<timestamp/>
</latestAdditionalFields>
<location>
<city>Mol</city>
<houseNumber>61</houseNumber>
<latitude>51.1802863</latitude>
<longitude>5.0968408</longitude>
<street>Ezaartveld</street>
<zipCode>2400</zipCode>
</location>
<priority>PRIO_1</priority>
<remarks></remarks>
<scenario>
<id>2</id>
<language>nl</language>
<code>636288d09c1541b6ef02d44c</code>
<accountId>1</accountId>
<description></description>
<isMedical>false</isMedical>
<isDeleted>false</isDeleted>
</scenario>
<time/>
<uniqueIdentifier>2023-11-22 14:20:29.299466</uniqueIdentifier>
</emcasIncident>
Authentication¶
Undoubtedly your environment is secured. Therefore, please add information that will allow us to send a valid request.
-
Basic: When you choose this option, you must provide a valid username and password combination that is valid for your environment.
-
Bearer: This is a fixed format in which you provide a token. Common authentication systems often provide this. Please note that the validity period of this token must be sufficiently long.
-
Custom: Choose your own specific header name that we will send and the value of that header. This is useful if you want to allow a special header for your webhook endpoint
Specific data formats¶
| Field | Description | Format |
|---|---|---|
phoneNo |
Caller's phone number | PhoneNumberFormat.E164 |
createdAt |
Timestamp of the call in Fireplug | ISO 8601 without timezone |
closedAt |
Time when the incident is automatically closed in Fireplug | ISO 8601 without timezone |
date |
Date of start at NC112 | yyyy-MM-dd |
time |
Time of start at NC112 | HH:mm:ss.SSS |
description |
The translation of the intervention code as known within NC112 | String |
remarks |
The additional data collected by NC112 during the call | String |
seqno |
The incident sequence number within NC112 | String |
code |
Intervention code as described in list of intervention codes | String |
scenario |
Detail of intervention code | Object |
numCasualties |
Number of victims (only filled in for medical intervention codes) | integer |
hc |
The name of the NC112 center that accepted the call | String |
callername |
The name of the caller | String |
callerref |
Reference to the call within NC112 | String |
services |
List of emergency services that have been notified | object |
Services¶
| Field | Description | Format |
|---|---|---|
servicetype |
Type of emergency services | POL/MED/BW/MIL/... |
servicename |
Name of the service as known in NC112: FA HVZ BRECHT Rand | String |
resourcetype |
For medical services an extension with more information about the vehicle type | MUG/PIT/AMB |
resourcename |
The name of the vehicle as known in NC112 | String |
hospitalname |
Name of the hospital to which possible victims are diverted | String |