Webhook¶
U kunt een eigen systeem op de hoogte brengen van een incident door een webhook-actie te definiëren
Sending data¶
Kies een HTTP methode om verwittigd te worden. Onze voorkeur gaat uit naar POST, maar de andere instellingen zijn ook mogelijk. Indien u de incidentgegevens ook daadwerkelijk wenst te ontvangen, moet u kiezen voor POST, PUT, DELETE of PATCH.
- Endpoint: De url waarop Fireplug een bericht kan sturen.
- Formaat: xml of json
- Method: POST, PUT, DELETE of 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>
Authenticatie¶
Ongetwijfeld is uw omgeving beveiligd. Voeg daarom informatie toe waarmee we een geldig verzoek kunnen sturen.
-
Basic: Waneer u deze optie kiest, moet u een geldige gebruikersnaam en wachtwoordcombinatie opgeven die geldig is voor uw omgeving.
-
Bearer: Dit is een vast formaat waarmee u een token meegeeft. Veelgebruikte authenticatiesystemen voorzien dit vaak. Let wel dat de geldigheidsperiode van dit token voldoende lang moet zijn.
- Custom: kies een eigen specifieke headernaam die wij gaan meesturen en de waarde van die header. Dit is nuttig als u een speciale header wilt toestaan voor uw webhook endpoint
Specific data formats¶
| Veld | Omschrijving | Formaat |
|---|---|---|
phoneNo |
Telefoon nummer van de beller | PhoneNumberFormat.E164 |
createdAt |
Timestamp van het ontvangen in Fireplug | ISO 8601 zonder tijdzone |
closedAt |
Tijd wanneer het incident automatisch word afgesloten in Fireplug | ISO 8601 zonder tijdzone |
date |
Datum van start bij NC112 | yyyy-MM-dd |
time |
Tijd van start bij NC112 | HH:mm:ss.SSS |
description |
De vertaling van de interventiecode zoals bekend binnen NC112 | String |
remarks |
De extra gegevens verzamelt door NC112 tijdens het gesprek | String |
seqno |
De volgnummer van het incident binnen NC112 | String |
code |
Interventiecode zoals beschrijving in lijst van interventiecodes | String |
scenario |
Detail van interventiecode | Object |
numCasualties |
Aantal slachtoffers (enkel ingevuld bij medische interventiecodes) | integer |
hc |
De benaming van het NC112 centrum dat het gesprek aannam | String |
callername |
De naam van de beller | String |
callerref |
Referentie naar het gesprek binnen NC112 | String |
services |
Lijst van hulpdiensten die verwittigd zijn | object |
Service¶
| Veld | Omschrijving | Formaat |
|---|---|---|
servicetype |
Type van hulpdiensten | POL/MED/BW/MIL/... |
servicename |
Naam van de dienst zoals bekend in NC112: FA HVZ BRECHT Rand | String |
resourcetype |
Voor medische diensten een uitbreiding met meer informatie over het voertuig type | MUG/PIT/AMB |
resourcename |
De naam van het voertuig zoals gekend in NC112 | String |
hospitalname |
Naam van het hospital waar eventuele slachtoffers worden naar afgeleid | String |