Skip to main content

Bulk Process Notifications

In addition to retrieving information about a Bulk's operation statuses, you can also instruct Weavr to send webhook updates on the bulk's execution progress.

This can be done when triggering a bulk via the POST /bulks/{bulk_id}/execute endpoint, using the optional field webhookInterval. 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 the webhookInterval to 25, Weavr will send a webhook after every 25 operations are processed, resulting in 4 webhooks.

If the field is left blank, the webhook will only be sent when the bulk process finishes.

note

The maximum number of webhooks that will be sent for a Bulk Process is 4. Therefore if the webhook interval is set to less than 25% of the total number of operations in the bulk, a webhook will still only be sent after each 25% of operations have been processed.

caution

The current bulk_process_end webhook will be renamed to bulk_process_progress to more accurately describe its function and will also start returning the operationStatusCounts described in the previous section.