Bulk upload status 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.

WEBHOOK bulk-upload

JSON

completedUpload

{
  "id": "Webhook:019542f5-b3e7-1d02-0000-000000000008",
  "type": "BULK_UPLOAD.COMPLETED",
  "timestamp": "2025-08-15T14:32:00Z",
  "data": {
    "id": "Job:019542f5-b3e7-1d02-0000-000000000006",
    "status": "COMPLETED",
    "progress": {
      "total": 5000,
      "processed": 5000,
      "successful": 5000,
      "failed": 0
    },
    "errors": []
  }
}

400

{
  "message": "<string>",
  "details": {}
}

Authorizations

X-Grid-Signature · string · header · required

Secp256r1 (P-256) asymmetric signature of the webhook payload, which can be used 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.

Body

application/json

id · string · required

Unique identifier for this webhook delivery (can be used for idempotency)

Example:

"Webhook:019542f5-b3e7-1d02-0000-000000000007"

type · enum<string> · required

Status-specific event type in OBJECT.EVENT dot-notation (e.g., OUTGOING_PAYMENT.COMPLETED)

Available options: BULK_UPLOAD.COMPLETED, BULK_UPLOAD.FAILED

timestamp · string<date-time> · required

ISO 8601 timestamp of when the webhook was sent

Example:

"2025-08-15T14:32:00Z"

data · object · required

Show child attributes

Response

200

Webhook received successfully