Status updates met Hooks (callbacks)
Om realtime updates en statusinformatie van jouw verzonden documenten te ontvangen en verwerken kan je naast gewone API calls ook gebruik maken van een mechanisme van "hooks".
Hier is hoe hooks werken:
- Realtime Statusinformatie: Onze hooks reageren automatisch op veranderingen in de status van jouw documenten. Hierdoor kun je real-time updates ontvangen over de voortgang van jouw zendingen.
- Aanpasbare Acties: Je kan de hooks gebruiken om de status van de verzending ook in jouw systeem aan te passen of specifieke acties te doen bij specifieke statussen van de verzending.
- Geen nood om te pollen: Hooks zorgen ervoor dat je niet telkens de status van een verzending moet opvragen waardoor er minder API calls uitgevoerd moeten worden.
Hooks kunnen beheerd worden via de /api/callback-configurations.
Een callback zal steeds een HTTP POST zijn op het door jou ingestelde endpoint.
De body van zo'n callback zal er als volgt uitzien:
{
"EventName" = " DocumentStatusUpdated",
"OccuredAtUtc" = "DateTime.UtcNow",
"Properties" = [
{
"Key" = "NewStatus",
"Value" = "StatusEnumValue"
},
{
"Key" = "DocumentReference",
"Value" = "documentReference"
},
{
"Key" = "ExternalId",
"Value" = "documentExternalId"
}
]
}
EventName: Dit zal steeds "DocumentStatusUpdated" zijn.
DocumentReference: De referentie van het document zoals door jouw meegegeven bij het uploaden van het document. Bij het uploaden is dit veld optioneel. Als je het niet hebt meegegeven bij het uploaden, dan zal deze Property niet meegegeven worden.
ExternalId: De unieke ID van een document in Postbird. Deze ID wordt teruggegeven bij het uploaden van het document.
StatusEnumValue: Bevat de nieuwe status van het document. Mogelijke waarden zijn:
UploadAwaiting = 0, // Het document is opgeladen in ons systeem en wacht op verwerking
UploadError = 1, // Er ging iets fout bij het opladen in ons systeem
UploadOk = 2, // Het document is goed opgeladen en staat klaar voor verdere verwerking
PdfCriticalValidationAwaiting = 3, // Postbird is begonnen met de validatie van het PDF document
PdfCriticalValidationError = 4, // Het document is geen geldige PDF of het papier formaat is ongeldig (geen A4)
PdfCriticalValidationOk = 5, // Postbird heeft de validatie van het PDF document succesvol afgerond
AddressAwaiting = 6, // Postbird start de validatie van het adres
AddressError = 7, // Het adres heeft geen geldige structuur of werd niet gevonden
AddressOk = 8, // Het adres is correct
PaymentAwaiting = 9, // Postbird is de betaling van het document gestart
PaymentError = 10, // Er ging iets mis met de betaling van het document (onvoldoende saldo)
PaymentOk = 11, // Het document is betaald
SentToNotificationService = 12, // Het document werd verzonden naar het print center
SentToNotificationServiceError = 13, // Er ging iets mis bij het verzenden van het document naar het print center
AwaitingPrint = 14, // Het document wacht in het print center op afdruk
Printed = 15, // Het document werd afgedrukt
Send = 16, // Het document werd afgeleverd aan de postale operator
NotDelivered = 17, // Het document werd niet afgeleverd aan de ontvanger (foutief adres, verhuisd, ...)
NormalSendingFailed = 18, // De postale operator kon het document niet uitreiken
Delivered = 19, // Het aangetekende document werd uitgereikt
Canceled = 99 // Het document werd door een Postbird medewerker geannuleerd (op vraag van de klant)
Lees verder: Enums