---
title: "Bulk upload status webhook"
method: POST
path: "bulk-upload"
tags: ["Webhooks"]
---

# Bulk upload status webhook

`POST bulk-upload` (webhook)

Webhook that is called when a bulk customer upload job completes or fails.
This endpoint should be implemented by clients of the Grid API.

### Authentication
The webhook includes a signature in the `X-Grid-Signature` header that allows you to verify that the webhook was sent by Grid.
To verify the signature:
1. Get the Grid public key provided to you during integration
2. Decode the base64 signature from the header
3. Create a SHA-256 hash of the request body
4. Verify the signature using the public key and the hash

If the signature verification succeeds, the webhook is authentic. If not, it should be rejected.

This webhook is sent when a bulk upload job completes or fails, providing detailed information about the results.

## Payload

- BulkUploadWebhook
  - `id` string, required — Unique identifier for this webhook delivery (can be used for idempotency)
  - `type` 'BULK_UPLOAD.COMPLETED' | 'BULK_UPLOAD.FAILED', required — Type of webhook event in OBJECT.EVENT dot-notation. The part before the dot identifies the resource, the part after identifies the event. This lets consumers route purely on type without inspecting data.status.
  - `timestamp` string, date-time, required — ISO 8601 timestamp of when the webhook was sent
  - `data` BulkCustomerImportJob, required
    - `id` string, required — Unique identifier for the bulk import job
    - `status` 'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED', required — Current status of the job
    - `progress` object, required
      - `total` integer, required — Total number of customers to process
      - `processed` integer, required — Number of customers processed so far
      - `successful` integer, required — Number of customers successfully created
      - `failed` integer, required — Number of customers that failed to create
    - `errors` BulkCustomerImportErrorEntry[] — Detailed error information for failed entries
      - `code` string — Error code
      - `message` string — Error message
      - `details` object — Additional error details
      - `correlationId` string, required — Platform customer ID or row number for the failed entry
    - `completedAt` string, date-time — Timestamp when the job completed (only present for COMPLETED or FAILED status)

## Acknowledgement `200`

Webhook received successfully

## Other responses

- `400` — Bad request
- `401` — Unauthorized - Signature validation failed
- `409` — Conflict - Webhook has already been processed (duplicate id)

---

[API](https://skmtc.net/stainless-api/apis/grid-api.md) · [All operations](https://skmtc.net/stainless-api/apis/grid-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stainless-api/grid-api/revisions/151f2d9bad9c/schema)