By default the PSB sends a webhook notification immediately for every received document. At high volumes it can be more efficient to process documents periodically in bulk. With a batch hook the PSB collects all events during a configurable period and packages them into a ZIP archive.

A batch hook listens on a topic (for example InvoiceReceived) and collects all events that come in during a given period. After the period ends, the PSB creates a ZIP file containing all the documents associated with those events. The PSB then publishes a new topic ({Topic}Batched) so you can download the archive.

The flow is as follows:

1. The PSB receives documents and registers events
2. The batch hook collects events until the period has elapsed or the maximum count is reached
3. The PSB creates a ZIP archive of all collected documents
4. A {Topic}Batched event is published (for example InvoiceReceivedBatched)
5. Your webhook receives the batched event and downloads the ZIP archive

Register a hook via the API with a batch://zip action:

{
  "action": "batch://zip?period=00:15:00&maxBatchSize=100",
  "topics": ["InvoiceReceived"]
}

Tip: choose the period and maxBatchSize based on your document volume. At low volumes you can set a longer period (for example one hour). At high volumes a shorter period with a higher maxBatchSize is more practical.

After closing a batch the PSB publishes a new event on the topic {Topic}Batched. The naming follows a fixed pattern:

Set up a regular webhook on the batched topic to retrieve the ZIP archive:

{
  "action": "https://jouw-endpoint.nl/batches",
  "topics": ["InvoiceReceivedBatched"],
  "secret": "jouw-geheime-sleutel"
}

The ZIP file contains all documents collected in the batch, each as a separate XML file. The file names are based on the documentId. The archive can be downloaded via the URL provided in the batched event.

You can combine batch hooks with regular webhooks. For example, use a regular webhook for immediate processing of urgent documents and a batch hook for periodic bulk import into your ERP system. Make sure you do not process documents twice if you have both hooks on the same topic.

Note: batch hooks use the same retry logic as regular webhooks. If the batched event is not delivered successfully, the PSB retries for up to 5 days.

See the full API specification at psb.econnect.eu for all configuration options.

• Configure and secure webhooks
• Configure e-mail hooks
• Receive an invoice via the API
• Integration methods overview
• Receive notifications on the platform