Batch

Webhook events related to an InsCipher batch, which can be thought of as a transaction import for multiple transactions.

Batch Status Updated to 'Processed'

Receive a webhook event when there is a status change of an individual batch containing transactions to the 'Processed' status within InsCipher.

Limitations

This webhook can only be created at the Agency Admin level.

Use Cases

Connect clients: Batch CSV Import
A user uploads a CSV file via the Batch Importer tool within the portal.
Connect and Filing Services Clients: Batches imported via Integration or API
A batch is imported via Integration or via Transaction Import API call.

Request Examples

{
  "event_id": 12,
  "event": "webhook.batch.status.processed",
  "timestamp": "2024-09-10 07:51:27",
  "batch_id": "e455acef2249e49bb04476226750f9fc",
  "status": "processed",
  "transactions": [
    {
      "policy_number": "AAM05001801",
      "transaction_id": 167254,
      "status_message": "Submitted",
      "warnings": [
        "Required document is missing",
        "Total values don't match. Provided - 6569.78. Calculated - 6574.06",
        "Description of risk not provided or not found",
        "Missing Insurance Company",
        "Line of business is invalid",
        "Stamping fee values don't match. Provided - 11.20. Calculated - 15.50",
        "Retail producer not provided"
      ]
    },
    {
      "policy_number": "AAM05001802",
      "transaction_id": 167255,
      "status_message": "Submitted",
      "warnings": [
        "Required document is missing",
        "Transaction total values don't match. Provided - 6569.78. Calculated - 6574.10",
        "Description of risk not provided or not found",
        "Missing Insurance Company",
        "Line of business is invalid",
        "Stamping fee values don't match. Provided - 11.10. Calculated - 15.40",
        "Retail producer not provided",
        "Layered risk not provided",
        "Risk retention group not provided"
      ]
    }
  ]
}

Batch Status Failed

Receive a webhook event when the processing status of a batch within InsCipher fails due to an internal system error.

Limitations

This webhook can only be created at the Agency Admin level.

Use Cases

While events stemming from InsCipher batch processing failures are very rare, subscribing to this event allows the user to receive instant notification in the case that a batch of transactions and/or documents imported into InsCipher have failed to process and thus needs action to be taken.

Request Examples

{
  "event_id": 170,
  "event": "webhook.batch.status.failed",
  "timestamp": "2025-04-03 09:53:35",
  "sent_at": "2025-04-03 09:53:35",
  "batch_id": "b0b11d49e06e265b66eb3a02a7d3f2e4",
  "status": "failed",
  "errors": "Internal system error",
  "transactions": [
    {
      "id": "12345",
      "unique_id": "as.d.as.d.aasd",
      "policy_number": "XLC1919",
      "policy_effective_date": "2024-12-10",
      "invoice_number": "52882",
      "agent_id": "5"
    }
  ]
}

Updated 16 days ago