Bulk process webhook events
In addition to retrieving information about a Bulk Process's operation statuses, you can instruct Weavr to send webhook updates on the bulk's execution progress.
You set this up when triggering a bulk via the POST /bulks/{bulk_id}/execute endpoint, using the optional webhookInterval field. This field accepts a number which indicates the number of operations after which a webhook should be sent. For example, if a bulk contains 100 operations and you set webhookInterval to 25, we send a webhook after every 25 operations are processed, resulting in 4 webhooks.
If you omit webhookInterval (or send null), the webhook is only sent once, when the bulk processBulk Process A task created when initiating a group of bulk operations. The Bulk Process has a consistent lifecycle (statuses) and management method, regardless of the type of operation being performed. It can be in states such as SUBMITTED, RUNNING, PAUSED, CANCELLED, or completed states. finishes.
The maximum number of webhooks sent for a Bulk ProcessBulk Process A task created when initiating a group of bulk operations. The Bulk Process has a consistent lifecycle (statuses) and management method, regardless of the type of operation being performed. It can be in states such as SUBMITTED, RUNNING, PAUSED, CANCELLED, or completed states. is 4. If you set webhookInterval to less than 25% of the total number of operations in the bulk, a webhook is only sent after each 25% of operations have been processed.
Progress events are delivered via the bulk_process_end webhook, whose payload includes the operationStatusCounts field described in the previous section.