Manage

Bulk process progress

Sent as a bulk process runs and again when it finishes.

How often progress events arrive is set by webhookInterval on Execute bulk process, which is the number of operations between events. The effective minimum is 25% of the total, so a smaller value still yields four events across the run.

COMPLETED, PARTIALLY_COMPLETED, FAILED, and CANCELLED are final. On PARTIALLY_COMPLETED, read operationStatusCounts to see how many operations failed.

Enable and configure webhooks in the Embedder Portal; recent events are listed on its Webhook Logs page. Weavr sends this event to {Webhook URL}/bulk_process_end/watch.

postWebhook/bulk_process_end/watch

Headers

call-refstring

A call reference generated by the caller and unique to the caller to provide correlation between the caller and system with a maximum length of 255

published-timestampinteger required

The timestamp, expressed in Epoch timestamp using millisecond precision, when this event was published.

signaturestring required

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the published-timestamp using your API key.

signature-v2string required

The signature to verify the authenticity of this request. This is the base64 hash (HmacSHA256) of the call-ref + payload + published-timestamp using your API key.

Payload

bulkIdstring

The bulk id of the bulk process

status'RUNNING' | 'PARTIALLY_COMPLETED' | 'COMPLETED' | 'FAILED' | 'PAUSED' | 'CANCELLED'
submittedItemsCountinteger

The number of bulk operations in the bulk process

Example payload

{
  "bulkId": "123456789",
  "submittedItemsCount": 10,
  "operationStatusCounts": [
    {
      "count": 25
    }
  ]
}

Response

Event received.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.