Eventtypen
Deze pagina somt de events op die SHIPM8 stuurt, gegroepeerd per gebied. Van elk event krijgt u de trigger identificatie die u in het abonnement typt en het triggertype dat u ernaast kiest. Beide moeten kloppen, anders gaat het abonnement niet af — zie Een abonnement aanmaken.
Een identificatie lezen
De meeste identificaties bestaan uit drie delen:
$module_object_actie
- module — het onderdeel van SHIPM8 waar het event uit komt (
invoicing,nautical,customcontent, enzovoort). - object — het soort record (
invoice,visit, of de systeemcode van een van uw eigen objecten). - actie — wat er gebeurde (
add,update,finalized,eta, …).
Het eerste teken is van belang:
$— het event komt uit SHIPM8 zelf.@— het event komt van buiten, doorgestuurd door een extern systeem.
Sommige identificaties hebben maar twee delen, en geplande taken gebruiken een ID in plaats van een naam. Dat staat hieronder vermeld.
Facturatie
Events over facturen. Het record dat met het event meereist is de factuur zelf.
| Trigger identificatie | Triggertype | Gebeurt wanneer |
|---|---|---|
$invoicing_invoice_add | Creëren | Een factuur wordt aangemaakt — handmatig, door een facturatiestroom, of door een import. |
$invoicing_invoice_update | Bijwerken | Een factuur wordt gewijzigd. Het event draagt ook de lijst met gewijzigde velden mee. |
$invoicing_invoice_delete | Verwijderen | Een factuur wordt verwijderd. |
$invoicing_invoice_cancel | Algemeen | Een factuur wordt geannuleerd. |
$invoicing_invoice_split | Algemeen | Een factuur wordt in losse facturen gesplitst. |
$invoicing_invoice_finalized | Algemeen | Een factuur wordt definitief. |
$invoicing_invoice_pendingapproval | Algemeen | Een facturatiestroom zet een factuur klaar voor goedkeuring. |
$invoicing_invoice_pendingverification | Algemeen | Een facturatiestroom zet een factuur klaar voor verificatie. |
$invoicing_invoice_finalized is hier het werkpaard: dat is het moment waarop een factuur
vaststaat en klaar is om naar een boekhoudsysteem te gaan.
Uw eigen records (aangepaste gegevens)
Events op de objecten die u zelf inricht in Aangepaste gegevens. Omdat die objecten per organisatie verschillen, worden de identificaties opgebouwd uit de systeemcode van uw object — de korte code op de objectdefinitie:
$customcontent_<systeemcode>_<actie>
Een object met systeemcode order geeft dus $customcontent_order_add,
$customcontent_order_update, enzovoort.
| Actiedeel | Triggertype | Gebeurt wanneer |
|---|---|---|
_add | Creëren | Een record van dat soort wordt aangemaakt. |
_update | Bijwerken | Een record wordt gewijzigd. Draagt de lijst met gewijzigde velden mee. |
_delete | Verwijderen | Een record wordt verwijderd. |
_detach | Verwijderen | Een record wordt losgekoppeld van het record waaraan het hing. |
De inbox
Records die via de inbox binnenkomen — wachtend op goedkeuring voordat ze echte records
worden — hebben hun eigen module, customcontentinbox:
$customcontentinbox_<systeemcode>_<actie>
| Actiedeel | Triggertype | Gebeurt wanneer |
|---|---|---|
_add | Creëren | Een inboxitem wordt aangemaakt. |
_update | Bijwerken | Een inboxitem wordt gewijzigd. |
_delete | Verwijderen | Een inboxitem wordt verwijderd. |
_approve | Algemeen | Een inboxitem wordt goedgekeurd en wordt een echt record. |
_decline | Algemeen | Een inboxitem wordt afgewezen. |
_addshadow | Algemeen | Er wordt een schaduwkopie van een inboxitem gemaakt. |
Automatiseert u iets over het afgeronde record, gebruik dan customcontent. Gebruik
customcontentinbox alleen als de automatisering over het binnenkomen en goedkeuren van
inkomende gegevens gaat.
Havenbezoeken en bewegingen
Events die worden gestuurd terwijl SHIPM8 de havenaanloopgegevens bijhoudt vanuit de systemen van de haven zelf. Ze gaan af per gewijzigde waarde, dus de identificatie benoemt de waarde die wijzigde in plaats van een actie. Ze hebben allemaal triggertype Algemeen.
Voor een havenbezoek — de hele aanloop in de haven:
| Trigger identificatie | Gebeurt wanneer |
|---|---|
$nautical_visit_eta | De verwachte aankomsttijd wijzigt. |
$nautical_visit_ata | De werkelijke aankomsttijd wordt gezet. |
$nautical_visit_etd | De verwachte vertrektijd wijzigt. |
$nautical_visit_atd | De werkelijke vertrektijd wordt gezet. |
$nautical_visit_status | De status van het bezoek wijzigt. |
$nautical_visit_agent | De agent op het bezoek wijzigt. |
$nautical_visit_entrypoint | Het bezoek krijgt zijn invaarpunt. |
$nautical_visit_exitpoint | Het bezoek krijgt zijn uitvaarpunt. |
$nautical_visit_pierin | Het schip komt aan bij een ligplaats. |
$nautical_visit_pieruit | Het schip verlaat een ligplaats. |
$nautical_visit_lockentry | Het schip vaart een sluis in. |
$nautical_visit_lockexit | Het schip vaart een sluis uit. |
Voor een beweging — één traject binnen het bezoek:
| Trigger identificatie | Gebeurt wanneer |
|---|---|
$nautical_movement_eta | De verwachte aankomst van de beweging wijzigt. |
$nautical_movement_ata | De werkelijke aankomst van de beweging wordt gezet. |
$nautical_movement_etd | De verwachte vertrektijd van de beweging wijzigt. |
$nautical_movement_atd | De werkelijke vertrektijd van de beweging wordt gezet. |
$nautical_movement_agent | De agent van de beweging wijzigt. |
Over de onderliggende gegevens leest u meer in Havenbezoeken.
Aankomst- en vertrektijden worden in de aanloop naar een havenbezoek herhaaldelijk gecorrigeerd, dus een ETA-event kan voor één bezoek vele malen afgaan. Voeg voorwaarden toe zodat de automatisering alleen handelt wanneer het moet — bijvoorbeeld op de werkelijke tijden in plaats van de verwachte.
Documenten (data export)
Events die worden gestuurd nadat SHIPM8 iets heeft gemaakt en afgeleverd. Beide hebben triggertype Algemeen. De eventgegevens vermelden welk sjabloon is gebruikt, welke records het betrof, of het is gelukt, en eventuele foutmeldingen.
| Trigger identificatie | Gebeurt wanneer |
|---|---|
$contentdistribution_template_distribute | Er is een document gemaakt en verspreid vanuit een exportsjabloon. |
$contentdistribution_notification_distribute | Er is een meldingsbericht gemaakt en verspreid. |
Hiermee bouwt u "en leg daarna vast dat het is verstuurd" — zie Events aan elkaar koppelen.
Inkomende webhooks (externe systemen)
Als een gekoppeld systeem een wijziging naar SHIPM8 doorstuurt, komt die binnen als een
event met een @-prefix en maar twee delen:
@service_object
Het triggertype is Algemeen. Exact Online is de dienst die momenteel wordt
ondersteund, dus identificaties zien uit als @exactonline_salesinvoice of
@exactonline_purchaseentry — het objectdeel is het objecttype waarvoor de webhook aan de
kant van Exact Online is geregistreerd.
Anders dan bij de overige events zijn de gegevens hier de lading die het externe systeem stuurde, niet een SHIPM8-record. Daarom worden webhook-automatiseringen meestal gecombineerd met een actie Content distributie export extra gegevens of Content distributie importeren — zie Actietypen.
Het instellen van de webhook zelf is onderdeel van de koppeling; zie Exact Online.
Geplande taken
Een geplande taak heeft geen identificatie op basis van een naam. In plaats daarvan is het
ID van de taak — een lange code in de vorm 3f2a1b00-… — de trigger identificatie, en
is het triggertype Hangfire. De taak draait op zijn schema en geeft zijn gegevens door
aan het abonnement dat zijn ID draagt.
Zo bouwt u een terugkerende automatisering: de taak levert het wanneer, het abonnement levert het wat. Het ID krijgt u van de taak zelf.
Uw eigen ketenevents
Elke identificatie die u zelf verzint op het tabblad Triggers van een actie wordt een event waarop u zich kunt abonneren. Geef het triggertype Algemeen, tenzij u de naam bewust laat eindigen op een van de woorden die op Een abonnement aanmaken staan. Zie Events aan elkaar koppelen.
Als het event dat u nodig hebt er niet bij staat
Er komen events bij naarmate SHIPM8 groeit, en niet elke wijziging in de app stuurt er een. Staat het moment dat u wilt automatiseren niet in deze tabellen, vraag dan SHIPM8 support — soms is er een nabijgelegen event dat met de juiste voorwaarden werkt, en soms is het een kleine toevoeging aan onze kant.
Het triggertype Verwerkt bestaat voor events waarvan de naam eindigt op _processed.
Geen enkel gebied stuurt die momenteel, dus u hebt het nog niet nodig — het is
gereserveerd voor toekomstig gebruik.