1 Webhook Events
2 Definities
- 2.1 Event data
- 2.2 Resource data
  - 2.2.1 ConsignmentNoteResource
  - 2.2.2 JobBillingResource
  - 2.2.3 JobResource
  - 2.2.4 IMOrderDetailsResource
  - 2.2.5 InvoiceResource
  - 2.2.6 LocationResource
  - 2.2.7 OrderAttachment
  - 2.2.8 OrderChecklist
  - 2.2.9 OrderResource
  - 2.2.10 RelationResource
  - 2.2.11 TowingVehiclePositionResource
  - 2.2.12 VehicleResource
  - 2.2.13 DriverResource
  - 2.2.14 VehiclePickedUpReceiptResource
- 2.3 Overige data
  - 2.3.1 Address
  - 2.3.2 ChecklistItem
  - 2.3.3 ConsignmentNoteReference
  - 2.3.4 Coordinates
  - 2.3.5 InvoiceReference
  - 2.3.6 ImOrderReference
  - 2.3.7 JobBillingReference
  - 2.3.8 JobReference
  - 2.3.9 OrderAttachmentReference
  - 2.3.10 OrderChecklistReference
  - 2.3.11 OrderLocationReference
  - 2.3.12 MainRoad
  - 2.3.13 OrderReference
  - 2.3.14 RelationReference
  - 2.3.15 StatusReport
  - 2.3.16 TowingVehiclePositionReference
  - 2.3.17 VehicleProperties
  - 2.3.18 VehicleReference
  - 2.3.19 VehicleState
  - 2.3.20 DriverReference
3 Voorbeeld

Webhook Events

Overzicht van de verschillende webhook events waarop ingehaakt kan worden.

nl.assistanceonline.webhooks.orderstatuschanged.v1

Gaat af bij iedere mutatie van de dossierstatus. De huidige statussen die in AO voorkomen:

New (Nieuw)
Accepted (Geaccepteerd)
Assigned (Toegewezen)
EnRoute (Onderweg)
Arrived (Ter plaatse)
Loaded (Opgeladen)
InterimLocation (Op tussen bestemming)
Plannable (Planbaar voor doortransport, tweede behandeling aangemaakt)
TransportAfterFirstService (Doortransport toegewezen)
Destination (Eindbestemming, auto gelost op eindbestemming en opdracht gereed)
Invoiced (Gefactureerd)
Empty (Loze rit)
Canceled (Vervallen)
Credited (Gecrediteerd)

Wanneer de status Assigned of Arrived is, kan er indien ingesteld en beschikbaar de meest recente bergingsvoertuigpositie meegestuurd worden. Zie TowingVehiclePositionResource.

nl.assistanceonline.webhooks.jobetacalculated.v1

Gaat af zodra de chauffeur zich onderweg meldt richting de incidentlocatie. Hier kan een vertraging van 30 seconden inzitten.
Ook gaat dit event af als de planner de ETA herberekend.

Let op: Dit event gaat niet af voor transportopdrachten en opdrachten die toegewezen zijn aan een charter

Let op: Voor de ETA webhook kunnen kosten worden berekend.

nl.assistanceonline.webhooks.consignmentnoteadded.v1

Gaat af op het moment dat er een pdf voor een vrachtbrief is gegenereerd.

nl.assistanceonline.webhooks.orderattachmentadded.v1

Gaat af op het moment dat er een bijlage aan een opdracht is toegevoegd.

nl.assistanceonline.webhooks.invoicefinalized.v1

Gaat af op het moment dat de pdf van de factuur is gegenereerd. Dit is vlak nadat de factuur gefinaliseerd is.

nl.assistanceonline.webhooks.orderchecklistsaved.v1

Gaat af op het moment dat de antwoorden op een vragenlijst worden opgeslagen.

nl.assistanceonline.resources.vehicle-pickedup-receipt.v1

Gaat af op het moment dat een voertuig wordt afgehaald.

Definities

Hieronder wordt kort toegelicht hoe responses van de webhooks eruit komen te zien. De basis bestaat uit en CloudEvent met daarin één Event en optioneel een aantal Resources.

Event data

Ieder event heeft drie vaste velden, de overige velden zijn afhankelijk van het type event.

Veld	Type	Omschrijving	Voorbeeld

Veld

Type

Omschrijving

Voorbeeld

resourceReference

String

Referentie naar het resource voor het opvragen van meer details

/tenants/1/orders/fc9036ec-eb4a-496c-8c77-e972e3e800aa

eventType

String

Event type

nl.assistanceonline.webhooks.orderstatuschanged.v1

resources

Dictionary<string, ResourceBase>

Dictionary met alle resources. (eventueel gefiltered door de instelling in de webhook)

De key is de locatie in de API en resources refereren onderling via de key

"/tenants/1/orders/017a1434-117a-4d6f-8842-3fa81e0427d4": {

/* orderdata */

}

nl.assistanceonline.webhooks.orderstatuschanged.v1

Status mutaties van een dossier in AO:

{
    "orderNumber": "O-0000303",
    "previousStatus": "Accepted",
    "newStatus": "Assigned",
    "resourceReference": "/tenants/1/orders/017a1434-117a-4d6f-8842-3fa81e0427d4",
    "eventType": "nl.assistanceonline.webhooks.orderstatuschanged.v1",
    "resources": {
        "/tenants/1/orders/017a1434-117a-4d6f-8842-3fa81e0427d4": {
            /* orderdata */
        }
    }
}

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
orderNumber	String	Ordernummer zoals bekend in AO Let op: Dit veld is leeg bij nog niet geaccepteerde opdrachten	O-2387923
previousStatus	String	Vorige opdrachtstatus (zie OrderStatusChanged voor events) Let op: Dit veld is None (leeg) bij opdrachten met de status ‘New’	New
newStatus	String	Nieuwe opdrachtstatus	Accepted

nl.assistanceonline.webhooks.jobetacalculated.v1

json voorbeeld bericht

{
    "eta": "2021-11-01T13:41:10+01:00",
    "startLocation": "/tenants/1/orders/017ccb9f-4659-40e9-accb-1f8fe215bb31/locations/017ccb9f-467b-4fde-b14f-463fe651d7de",
    "destination": "/tenants/1/orders/017ccb9f-4659-40e9-accb-1f8fe215bb31/locations/017ccb9f-467b-4fde-b14f-463fe651d7de",
    "timestamp": "2021-11-01T11:17:16.3991916+01:00",
    "orderNumber": "O-0000090",
    "imNumber": null,
    "jobType": "BreakDownAssistance",
    "resourceReference": "/tenants/1/jobs/017ccb9f-cf0b-4097-8ee4-78f9e48e0584",
    "eventType": "nl.assistanceonline.webhooks.jobetacalculated.v1",
    "resources": {
        "/tenants/1/jobs/017ccb9f-cf0b-4097-8ee4-78f9e48e0584": {
            /* jobdata */
        }
    }
}

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
eta	DateTimeOffset	Het verwachte tijdstip dat de chauffeur ter plaatse is bij de incidentlocatie	2021-11-01T13:41:10+01:00
startLocation	OrderLocationResourceReference	Referentie naar de incidentlocatie	Zie OrderLocationReference
destination	OrderLocationResourceReference	Referentie naar de eindbestemming van de behandeling. Dit kan bijvoorbeeld het depot zijn van de berger of het thuisadres van de berijder	Zie OrderLocationReference
timestamp	DateTimeOffset	Het tijdstip waarop de ETA berekend is	2021-11-01T11:17:16.3991916+01:00
orderNumber	String	Opdrachtnummer binnen AO. Deze is leeg als het om een IM-opdracht gaat.	O-0000090
imNumber	String	IM-nummer. Deze is leeg als het om een normale opdracht gaat.	LCM20123456-IM
jobType	String	Behandelingstype: BreakDownAssistance (Pechhulp) PlannableTransport (Planbaar transport) VehicleStorage (Stalling) Salvage (Berging) ErrorParked (Foutparkeerder) Cleaning (Reiniging) Im (IM melding) TransportAfterFirstService (Doortransport) LostCargo (Afgevallen lading) NonPlannableTransport (Niet planbaar transport Seizure (Inbeslagname) Security (Beveiliging) AbandonedVehicle (Achtergelaten voertuig) StandBy (Standby dienst)	BreakDownAssistance

nl.assistanceonline.webhooks.consignmentnoteadded.v1

json voorbeeld bericht

{
    "type": "load",
    "downloadUrl": "url with sastoken",
    "orderNumber": "O-0000357",
    "generatedAt": "2021-11-16T13:02:13.2278412+01:00",
    "resourceReference": "/tenants/1/orders/017d2890-01ff-4c40-bbe4-577bb50013df/consignment-notes/Load",
    "eventType": "nl.assistanceonline.webhooks.consignmentnoteadded.v1",
    "resources": {
        "/tenants/1/orders/017d2890-01ff-4c40-bbe4-577bb50013df/consignment-notes/Load": {
            // consignmentnote data
        }
    }
}

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
type	String	Moment waarvoor de vrachtbrief is gegenereerd	Load of Unload
downloadUrl	String	Url naar document incl sas-token. Deze is 7 dagen geldig.
orderNumber	String	Ordernumber binnen AO	O-0000090
generatedAt	DateTimeOffset	Tijdstip waarop vrachtbrief is gegenereerd

nl.assistanceonline.webhooks.orderattachmentadded.v1

json voorbeeld bericht

{
    "downloadUrl": "url met sastoken",
    "name": "download (1).jfif",
    "orderNumber": "O-0000357",
    "description": "beschrijving bijlage",
    "documentType": "IndemnityCertificate",
    "resourceReference": "/tenants/1/orders/017d2890-01ff-4c40-bbe4-577bb50013df/attachments/e32ea561-2ee5-45f6-8056-d4cf5b6e2c10",
    "eventType": "nl.assistanceonline.webhooks.orderattachmentadded.v1",
    "resources": {
        "/tenants/1/orders/017d2890-01ff-4c40-bbe4-577bb50013df/attachments/e32ea561-2ee5-45f6-8056-d4cf5b6e2c10": {
            // order attachment data
        }
    }
}

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
downloadUrl	String	Url naar document incl sas-token. Deze is 7 dagen geldig.
name	String	Naam van het bestand
orderNumber	String	Ordernumber binnen AO	O-0000090
description	String	Omschrijving
documentType	String	Type bijlage	IndemnityCertificate, MobilityDocument

nl.assistanceonline.webhooks.invoicefinalized.v1

json voorbeeld bericht

{
    "downloadUrl": "url met sastoken",
    "invoiceNumber": 21000009,
    "resourceReference": "/tenants/1/invoices/017d528c-e5d8-487a-90a4-dfbb22a31bac",
    "eventType": "nl.assistanceonline.webhooks.invoicefinalized.v1",
    "resources": {
        "/tenants/1/invoices/017d528c-e5d8-487a-90a4-dfbb22a31bac": {
            // invoice data
        }
    }
}

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
downloadUrl	String	Url naar de pdf van de factuur incl sas-token. Deze is 7 dagen geldig.
invoiceNumber	Long	Factuurnummer	21000009

nl.assistanceonline.webhooks.orderchecklistsaved.v1

json voorbeeld bericht

{
    "orderNumber": "O-0000151",
    "answeredAt": "2022-03-03T13:31:16.956+01:00",
    "externalIdentifier": null,
    "isExternal": false,
    "resourceReference": "/tenants/1/orders/017f1beb-407a-4def-b707-1ce5dea9b2ed/order-checklists/017f1beb-4455-47eb-9772-f97f12f815a2",
    "eventType": "nl.assistanceonline.webhooks.orderchecklistsaved.v1",
    "resources": {
        "/tenants/1/orders/017d2890-01ff-4c40-bbe4-577bb50013df/consignment-notes/Load": {
            // consignmentnote data
        }
    }
}

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
orderNumber	String	Ordernumber binnen AO	O-0000151
answeredAt	DateTimeOffset	Tijdstip waarop de vragenlijst is beantwoord
externalIdentifier	String	Referentie van de opdrachtgever naar de vragenlijst
isExternal	Boolean	Indicatie of de vragenlijst extern (door opdrachtgever meegegeven aan de opdracht) of intern (door berger ingericht) is

nl.assistanceonline.resources.vehicle-pickedup-receipt.v1

json voorbeeld bericht

{
  "downloadUrl": "url met sastoken",
  "orderNumber": "O-0000162",
  "generatedAt": "2024-06-26T05:22:14.009Z",
  "resourceReference": "/tenants/1/orders/01904ee7-7ee9-4ec6-8b6c-35dbbc698778/vehicle-pickedup-receipt",
  "eventType": "nl.assistanceonline.resources.vehicle-pickedup-receipt.v1",
  "resources": {
    "/tenants/1/orders/01904ee7-7ee9-4ec6-8b6c-35dbbc698778/vehicle-pickedup-receipt": {
      "downloadUrl": "url met sastoken",
      "order": "/tenants/1/orders/01904ee7-7ee9-4ec6-8b6c-35dbbc698778",
      "resourceType": "nl.assistanceonline.resources.vehicle-pickedup-receipt.v1",
      "resourceReference": "/tenants/1/orders/01904ee7-7ee9-4ec6-8b6c-35dbbc698778/vehicle-pickedup-receipt"
    }
  }
}

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
downloadUrl	String	Url naar de pdf van de factuur incl sas-token. Deze is 7 dagen geldig.
orderNumber	String	Ordernumber binnen AO	O-0000151
createdAt	DateTimeOffset	Tijdstip waarop het afhaalbewijs is aangemaakt.

Resource data

Iedere resource bevat twee standaard velden:

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
resourceReference	String	Referentie naar het resource voor het opvragen van meer details	/tenants/1/orders/fc9036ec-eb4a-496c-8c77-e972e3e800aa
resourceType	String	Typering van de resource. B.v. Order, Job, Location, etc.	Order

ConsignmentNoteResource

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
type	String	Moment waarvoor de vrachtbrief is gegenereerd	Load of Unload
downloadUrl	String	Url naar document incl sas-token. Deze is 7 dagen geldig.
Order	OrderReference	Referentie naar de OrderResource	Zie OrderReference

JobBillingResource

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
type	String	Soort doorbelasting: Automatic (Behorende bij een behandeling) Manual (Aanvullende facturatie, handmatig toegevoegd) VehicleStorage (Stallingsbehandeling) StandByShift (Standbydienst)	Automatic
customerOrderNumber	String	Inkoopopdrachtnummer	S1234235
debtor	RelationReference	Referentie naar debiteurinformatie	Zie RelationReference
invoice	InvoiceReference	Referentie naar factuurinformatie (InvoiceResource wordt nog niet meegestuurd)	Zie InvoiceReference

JobResource

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
type	String	Behandelingstype: BreakDownAssistance (Pechhulp) PlannableTransport (Planbaar transport) VehicleStorage (Stalling) Salvage (Berging) ErrorParked (Foutparkeerder) Cleaning (Reiniging) Im (IM melding) TransportAfterFirstService (Doortransport) LostCargo (Afgevallen lading) NonPlannableTransport (Niet planbaar transport Seizure (Inbeslagname) Security (Beveiliging) AbandonedVehicle (Achtergelaten voertuig) StandBy (Standby dienst)	BreakDownAssistance
solution	String	Tekstuele toelichting van uitgevoerde werkzaamheden	Band gepropt en garage advies gegeven
solutionRemark	String	Opmerking voor opdrachtgever zoals opgegeven bij Werkzaamheden	Auto onbestuurbaar
executeAfterDateTime	DateTimeOffset	Optioneel opgegeven tijdstip vanaf wanneer de opdracht uitgevoerd mag worden	2020-11-06T14:36:00.000+02:00
executeBeforeDateTime	DateTimeOffset	Leadtijd, uiterste tijd om ter plaatse te zijn	2020-11-06T14:36:00.000+02:00
result	String	Behandelingsresultaat. Dit is afhankelijk van het type behandeling. Pechhulp specifiek: BreakdownAssistanceOk (Pechhulp geslaagd) BreakdownAssistanceNotRepairedTransportToDepot (Pechhulp naar depot) BreakdownAssistanceNotRepairedTransportToDestination (Pechhulp naar eindbestemming) BreakdownAssistanceTransportWithoutRepairAttempt (Transport zonder reparatiepoging) Berging specifiek: OwnStrength (Eigen kracht verder) SalvageDepot (Berging naar depot) SalvageFinalDestination (Berging naar eindbestemming) Overige uitkomsten: EmptyRide (Loze rit) JobResultOk (Behandeling afgerond) SecondSalvor (Tweede inzet gevraagd)	BreakdownAssistanceOk
locations	OrderLocationReference[]	Lijst met locatiereferenties	Zie OrderLocationReference
statusReports	StatusReports[]	Lijst met statusupdates	Zie StatusReport
order	OrderReference	Referentie naar de opdracht, kan leeg zijn	Zie OrderReference
imOrder	ImOrderReference	Referentie naar de imOpdracht, kan leeg zijn	Zie ImOrderReference

IMOrderDetailsResource

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
imNumber	String	IM-nummer	LCM20123456-IM
llNumber	String	LL-nummer	LCM20123456-1
receivedAt	DateTimeOffset	Datum en tijd van waarop de melding is ontvangen	2020-11-06T14:36:00.000+02:00
orders	OrderReference[]	Referenties naar opdrachtdossiers die zijn aangemaakt naar aanleiding van deze melding Let op: Bij nieuwe IM-melding is het mogelijk dat er nog geen opdrachten zijn aangemaakt.	Zie OrderReference
company	RelationReference	Referentie naar relatiedetails van de uitvoerende berger	Zie RelationReference
customer	RelationReference	Referentie naar relatiedetails van de opdrachtgever	Zie RelationReference
description	String	Tekstuele toelichting	WIS aanrijdend;Pa:1 Vluchtstrook rechts lekke band verkeerszijde
district	String	Rayon van deze melding	NH131
status	String	Voortgang van de melding Accepted (Geaccepteerd) Assigned (Toegewezen) Enroute (Onderweg) Arrived (Ter plaatse) Empty (Loze rit) Let op: Een IM-melding is klaar als de berger ter plaatse is en gaat dan verder in het gerelateerde opdrachtdossier of als de rit loosgemeld is.	Assigned
incidentLocation	OrderLocationReference	Locatie van het incident	Zie OrderLocationReference

InvoiceResource

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld
debtor	RelationReference	Referentie naar relatiedetails van de debiteur	Zie RelationReference
company	RelationReference	Referentie naar relatiedetails van de uitvoerende berger	Zie RelationReference
orders	List<OrderReference>	Lijst met referentie naar de opdrachten die in deze factuur zitten	Zie OrderReference
invoiceDate	DateTimeOffset	De factuurdatum	2020-11-06T14:36:00.000+02:00
paymentTerm	Integer	Betalingstermijn waarbinnen de factuur betaald moet zijn	30
period	Integer	Boekingsperiode: De maand waarin de factuur is geboekt	11
fiscalYear	Integer	Boekingsperiode: Het jaar waarin de factuur is geboekt	2021
invoiceNumber	Long	Factuurnummer	21000009
debtorNumber	String	Debiteurnummer	2142
downloadUrl	String	Url naar de pdf van de factuur incl sas-token. Deze is 7 dagen geldig.
totalAmount	decimal	Totaal bedrag van de factuur, incl. BTW
totalAmountExVat	decimal	Totaal bedrag van de factuur. excl. BTW

LocationResource

Veld	Type	Omschrijving	Voorbeeld

Veld	Type	Omschrijving	Voorbeeld

Webhooks

Webhook Events

nl.assistanceonline.webhooks.orderstatuschanged.v1

nl.assistanceonline.webhooks.jobetacalculated.v1

nl.assistanceonline.webhooks.consignmentnoteadded.v1

nl.assistanceonline.webhooks.orderattachmentadded.v1

nl.assistanceonline.webhooks.invoicefinalized.v1

nl.assistanceonline.webhooks.orderchecklistsaved.v1

nl.assistanceonline.resources.vehicle-pickedup-receipt.v1

Definities

Event data

nl.assistanceonline.webhooks.orderstatuschanged.v1

nl.assistanceonline.webhooks.jobetacalculated.v1

nl.assistanceonline.webhooks.consignmentnoteadded.v1

nl.assistanceonline.webhooks.orderattachmentadded.v1

nl.assistanceonline.webhooks.invoicefinalized.v1

nl.assistanceonline.webhooks.orderchecklistsaved.v1

nl.assistanceonline.resources.vehicle-pickedup-receipt.v1

Resource data

ConsignmentNoteResource

JobBillingResource

JobResource

IMOrderDetailsResource

InvoiceResource

LocationResource