Svix

Loop Webhook Event Types

This is the list of event types that we currently send.
For guidance on how to listen to these events, take a look at Svix's guide to consuming webhooks.

business-exception.created

An exception was created on an entity.

Example
JSON
{
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "business-exception.created",
  "exceptionName": "Variance over threshold",
  "exceptionTypeQid": "qid::business_exception_type:6b6b0a26-2404-4add-8519-89fc5f173c54",
  "qid": "qid::business_exception:6b6b0a26-2404-4add-8519-89fc5f173c54",
  "targetEntityQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "targetEntityType": "PAYABLE_INVOICE"
}

business-exception.deleted

An exception was deleted from an entity.

Example
JSON
{
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "business-exception.deleted",
  "exceptionName": "Variance over threshold",
  "exceptionTypeQid": "qid::business_exception_type:6b6b0a26-2404-4add-8519-89fc5f173c54",
  "qid": "qid::business_exception:6b6b0a26-2404-4add-8519-89fc5f173c54",
  "targetEntityQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "targetEntityType": "PAYABLE_INVOICE"
}

business-exception.reopened

An exception was reopened on an entity.

Example
JSON
{
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "business-exception.reopened",
  "exceptionName": "Variance over threshold",
  "exceptionTypeQid": "qid::business_exception_type:6b6b0a26-2404-4add-8519-89fc5f173c54",
  "qid": "qid::business_exception:6b6b0a26-2404-4add-8519-89fc5f173c54",
  "targetEntityQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "targetEntityType": "PAYABLE_INVOICE"
}

business-exception.resolved

An exception was resolved on an entity.

Example
JSON
{
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "business-exception.resolved",
  "exceptionName": "Variance over threshold",
  "exceptionTypeQid": "qid::business_exception_type:6b6b0a26-2404-4add-8519-89fc5f173c54",
  "qid": "qid::business_exception:6b6b0a26-2404-4add-8519-89fc5f173c54",
  "targetEntityQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "targetEntityType": "PAYABLE_INVOICE"
}

payable-invoice-review.completed

A payable invoice review was completed.

Example
JSON
{
  "auditStatus": "PUBLISHED",
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "payable-invoice-review.completed",
  "outcome": "FULLY_APPROVED",
  "payableInvoiceQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
}

payable-invoice.shipment-job-linked

A payable invoice was linked to a shipment job.

Example
JSON
{
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "payable-invoice.shipment-job-linked",
  "payableInvoiceQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "shipmentJobQid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
}

payable-invoice.shipment-job-unlinked

A payable invoice was unlinked from a shipment job.

Example
JSON
{
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "payable-invoice.shipment-job-unlinked",
  "payableInvoiceQid": "qid::payable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "shipmentJobQid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
}

payment.completed

A payment was completed

Example
JSON
{
  "completedAt": "2023-01-01T00:00:00.000Z",
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "payment.completed",
  "initiatedAt": "2023-01-01T00:00:00.000Z",
  "paymentDisplayId": "LP12345678",
  "paymentQid": "qid::payment:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
}

payment.failed

A payment failed.

Example
JSON
{
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "payment.failed",
  "failedAt": "2023-01-01T00:00:00.000Z",
  "initiatedAt": "2023-01-01T00:00:00.000Z",
  "paymentDisplayId": "LP12345678",
  "paymentQid": "qid::payment:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
}

payment.initiated

A payment was initiated.

Example
JSON
{
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "payment.initiated",
  "initiatedAt": "2023-01-01T00:00:00.000Z",
  "paymentDisplayId": "LP12345678",
  "paymentQid": "qid::payment:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
}

receivable-invoice.created

A receivable invoice was created.

Example
JSON
{
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "receivable-invoice.created",
  "receivableInvoiceQid": "qid::receivable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
}

receivable-invoice.finalized

A receivable invoice was finalized.

Example
JSON
{
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "receivable-invoice.finalized",
  "receivableInvoiceQid": "qid::receivable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
}

receivable-invoice.voided

A receivable invoice was voided.

Example
JSON
{
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "receivable-invoice.voided",
  "receivableInvoiceQid": "qid::receivable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
}

shipment-job-artifact.assessed

A shipment job artifact was assessed.

Example
JSON
{
  "artifactAssessedType": "PROOF_OF_DELIVERY",
  "artifactQid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "shipment-job-artifact.assessed",
  "shipmentJobQid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
}

shipment-job-artifact.assigned

A shipment job artifact was assigned.

Example
JSON
{
  "artifactQid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "shipment-job-artifact.assigned",
  "shipmentJobQid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
}

shipment-job-artifact.unassessed

A shipment job artifact was unassessed.

Example
JSON
{
  "artifactAssessedType": "PROOF_OF_DELIVERY",
  "artifactQid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "shipment-job-artifact.unassessed",
  "shipmentJobQid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
}

shipment-job-artifact.unassigned

A shipment job artifact was unassigned.

Example
JSON
{
  "artifactQid": "qid::artifact:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "shipment-job-artifact.unassigned",
  "shipmentJobQid": "qid::shipment_job:0ca6f700-4137-4d09-b44a-43bb8d7900c4"
}

test-event.created

Used for testing only.

Example
JSON
{
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "test-event.created",
  "optionalString": "hello",
  "randomUuid": "8e483944-9eb4-4f48-a8f7-f3043d8d7c4a"
}