Webhooks

Der understøttes på alle endpoints webhooks ved alle justeringer af data i Indexed PIM.

For nye elementer sendes der et .created event.

For eksisterende elementer der opdateres, sendes et .updated event.

For elementer som slettes, sendes der et .deleted event.

Webhook payload

En webhook indeholder følgende elementer:

• Entity som svare til product, brand eller andet endpoint

• Company

• App

• Event som svarer til products.created, products.updated eller products.deleted event.

• Workflow som beskriver den webhook der sendes afsted

• Revision som beskriver de data der er ændret i dette event

Webhooks og workers

Webhooks udsendes asynkront via workers. For at optimere driften, leverancen og respektere begrænsninger på eksterne kanaler, så er de opsat som følgende.

En kanal/app vil kun modtage webhooks fra een worker. Dette betyder at webhooks ikke kan modtages parallelt. Dette sikre imod høj belastning hos modtageren, dette sikre også at rækkefølgen af data og events respekteres.

Dette resulterer i en stabil integration.

Shared vs. dedikeret workers

En dedikeret worker, er en worker som kun håndtere webhooks for en app. Dette er velegnet til apps og konti som har mange webhooks der kan danne kø. Det vil sikre optimal leverance for denne konto og undgå at skabe kø for andre konti.

En shared worker er en worker som kan deles mellem flere apps. For konti hvor der ikke er så høj belastning, så vil flere apps eller konti kunne dele en worker uden at påvirker hinanden. Mindre køer kan dog forekomme ved bursts af opdateringer.

Shared workers er opdelt per app type. For at optimere driften kan eksempelvis Shopware app, dele konti på en Shopware dedikeret worker.

For mindre apps, deles der en shared Webhook worker.

Tilgængelige events som understøtter webhooks

Alle endpoints understøtter .created, .updated og .deleted

Produkter