036 535 80 70 helpdesk@reflex-systems.nl
Documentatie

Webhook-verzoek payload

2026-01-13 07:53 UTC
English
Webhooks

Bij elk webhook-verzoek dat ReflexBlue verstuurt, wordt een payload meegestuurd. Deze payload bevat informatie waarmee het externe systeem kan bepalen welke gegevens zijn gewijzigd. De payload is altijd opgebouwd in het JavaScript Object Notation (JSON) formaat. De inhoud van de payload verschilt per webhook-gebeurtenistype.

In deze sectie vind je een overzicht van de verschillende soorten payloads die ReflexBlue kan versturen, inclusief de specificaties van hun eigenschappen en datatypes.

Webhook-payloadtypes

DefaultWebhookPayload

Voor de meeste webhook-gebeurtenistypes stuurt ReflexBlue een payload mee van het type DefaultWebhookPayload. In de onderstaande tabel zie je de eigenschappen van deze payload.

Eigenschap Type Omschrijving
EventTypeName tekst De naam van het type webhook-gebeurtenis.
EntityCode numeriek De code van de entiteit.
EntityId guid Het unieke ID van de entiteit.
Sequence numeriek Het rijversienummer van de entiteit.

Let op: In ReflexBlue kun je de EntityCode van een entiteit aanpassen (zoals de artikelcode bij een artikel of relatiecode bij een relatie). Gebruik daarom voor het koppelen met je eigen data altijd de EntityId, omdat deze uniek is en niet verandert.

Voorbeeld

Onderstaand is een voorbeeld van een JSON payload van een Relatie bijgewerkt (webhook://relations.relationupdated) webhook gebeurtenis.

{
    "eventTypeName": "webhook://relations.relationupdated",
    "entityCode": 27099,
    "entityId": "fe986a6e-c10e-473e-b914-6af858ea129e",
    "sequence": 963742
}

OrderWebhookPayload

Bij webhook gebeurtenistypes Order toegevoegd, Order bijgewerkt en Order verwijderd, wordt er een payload van het type OrderWebhookPayload meegestuurd met elke webhoek-verzoek vanuit ReflexBlue. De onderstaande tabel geeft een overzicht van de eigenschappen in deze payload.

Eigenschap Type Omschrijving
EventTypeName tekst De naam van het type van de webhook gebeurtenis.
EntityCode numeriek De code van de order.
EntityId guid De ID van de order.
Sequence numeriek Het rijversienummer van de order.
OrderDeleted boolean Geeft aan als de order is verwijderd.
OrderStatus OrderStatus De orderstatus.
OrderType OrderType Het ordertype.
OrderSubType OrderSubType Het ordersubtype.
IsConceptOrder boolean Geeft aan als het een concept order betreft.
DynamicFieldValues DynamicFieldValue Een lijst van dynamische veld waarden voor de order.
RelationId guid De ID van de relatie voor wie de order is bestemd.
RelationCode numeriek De code van de relatie.
RelationName tekst De naam van de relatie.
RelationDynamicFieldValues DynamicFieldValue Een lijst van dynamische veld waarden voor de relatie.

Voorbeeld

Onderstaand is een voorbeeld van een JSON payload van een Order bijgewerkt (webhook://order.orderupdated) webhook gebeurtenis.

{
 "eventTypeName": "webhook://order.orderupdated",
 "entityCode": 279,
 "entityId": "d81b3e96-2a93-4f65-beea-5013169664b9",
 "sequence": 963718,
 "orderStatus": "Open",
 "orderType": "Sales",
 "orderSubType": "Default",
 "dynamicFieldValues": [{
  "dynamicField": {
   "type": "Text",
   "name": "Externe ID",
   "identifier": "EXTERNE_ID",
   "id": "1804a9ed-cd6e-4224-99b4-47d60246a676",
  },
  "textValue": "A23456"
 }],
 "relationId": "fe986a6e-c10e-473e-b914-6af858ea129e",
 "relationCode": 27099,
 "relationName": "John Smith",
 "relationDynamicFieldValues": []
}

Data types

OrderStatus

Eigenschappen van het type OrderStatus kunnen de onderstaande waarden hebben.

Waarden Omschrijving
Open Geeft aan dat de order open is.
Closed Geeft aan dat de order gesloten is.

OrderType

Eigenschappen van het type OrderType kunnen de onderstaande waarden hebben.

Waarden Omschrijving
Sales Geeft aan dat het een verkooporder betreft.
Purchase Geeft aan dat het een inkooporder betreft.

OrderSubType

Eigenschappen van het type OrderSubType kunnen de onderstaande waarden hebben.

Waarden Omschrijving
Default Geeft aan dat het een default type betreft.
Approve Geeft aan dat het een acceptatie order betreft.
Return Geeft aan dat het een retour order betreft.
Backorder Geeft aan dat het een backorder betreft.
Edi Geeft aan dat het een EDI-order betreft (EDI staat voor Electronic Data Interchange).
EdiReturn Geeft aan dat het een EDI-retourorder betreft.

DynamicField

Eigenschappen van het type DynamicField kunnen de onderstaande eigenschappen hebben.

Eigenschap Type Omschrijving
Id guid De ID van het dynamisch veld.
Type DynamicFieldType Het type van het dynamisch veld.
Name tekst De naam van het dynamisch veld.
Identifier tekst De identifier van het dynamisch veld.
Description tekst De omschrijving van het dynamisch veld.

DynamicFieldValue

Eigenschappen van het type DynamicFieldValue kunnen de onderstaande eigenschappen hebben.

Eigenschap Type Omschrijving
DynamicField DynamicField Het dynamisch veld waarvan dit de waarde is.
NumberValue numeriek De numerieke waarde.
DecimalValue decimaal De decimaal waarde.
TextValue tekst De tekstwaarde.
DateTimeValue datumtijd De datum en tijd waarde.
TimeValue tijd De tijd waarde.
DateValue datum De datum waarde.
BooleanValue boolean De boolean waarde.
ChoiceValue DynamicFieldChoice De keuze waarde.
EntityValue guid De ID van de entiteit die als waarde is opgegeven.

DynamicFieldChoice

Eigenschappen van het type DynamicFieldChoice kunnen de onderstaande eigenschappen hebben.

Eigenschap Type Omschrijving
Value tekst De waarde van de keuze.

DynamicFieldType

Eigenschappen van het type DynamicFieldType kunnen de onderstaande waarden hebben.

Waarden Omschrijving
Choice Geeft aan dat het een keuze dynamisch veld betreft.
Text Geeft aan dat het een tekst dynamisch veld betreft.
MultiLine Geeft aan dat het een tekst met meerdere regels dynamisch veld betreft.
Hyperlink Geeft aan dat het een hyperlink dynamisch veld betreft.
Boolean Geeft aan dat het een boolean dynamisch veld betreft.
Date Geeft aan dat het een datum dynamisch veld betreft.
Time Geeft aan dat het een tijd dynamisch veld betreft.
DateTime Geeft aan dat het een datum en tijd dynamisch veld betreft.
Decimal Geeft aan dat het een decimaal dynamisch veld betreft.
Number Geeft aan dat het een numeriek dynamisch veld betreft.
RTF Geeft aan dat het een Rich Text Format (RTF) dynamisch veld betreft.
WarningMessage Geeft aan dat het een waarschuwingsbericht dynamisch veld betreft.
Article Geeft aan dat het een artikel dynamisch veld betreft.
Relation Geeft aan dat het een relatie dynamisch veld betreft.
RelationGroup Geeft aan dat het een relatiegroep dynamisch veld betreft.
ArticleGroup Geeft aan dat het een artielgroep dynamisch veld betreft.
RelationDocument Geeft aan dat het een relatiedocument dynamisch veld betreft.
User Geeft aan dat het een gebruiker dynamisch veld betreft.
Country Geeft aan dat het een land dynamisch veld betreft.

Navigatie

Zoeken

Geen resultaten.