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.

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

exceptionName

string

The name of the business exception.

exceptionTypeQid

string

(qid)

The unique identifier for the business exception type. This provides a reliable way to identify the business exception type if the name changes.

qid

string

(qid)

The qualified unique identifier for the business exception.

targetEntityQid

string

(qid)

Qualified unique identifier for the entity.

targetEntityType

string

The entity type for which the business exception is associated.

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"
}

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

exceptionName

string

The name of the business exception.

exceptionTypeQid

string

(qid)

The unique identifier for the business exception type. This provides a reliable way to identify the business exception type if the name changes.

qid

string

(qid)

The qualified unique identifier for the business exception.

targetEntityQid

string

(qid)

Qualified unique identifier for the entity.

targetEntityType

string

The entity type for which the business exception is associated.

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"
}

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

exceptionName

string

The name of the business exception.

exceptionTypeQid

string

(qid)

The unique identifier for the business exception type. This provides a reliable way to identify the business exception type if the name changes.

qid

string

(qid)

The qualified unique identifier for the business exception.

targetEntityQid

string

(qid)

Qualified unique identifier for the entity.

targetEntityType

string

The entity type for which the business exception is associated.

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"
}

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

exceptionName

string

The name of the business exception.

exceptionTypeQid

string

(qid)

The unique identifier for the business exception type. This provides a reliable way to identify the business exception type if the name changes.

qid

string

(qid)

The qualified unique identifier for the business exception.

targetEntityQid

string

(qid)

Qualified unique identifier for the entity.

targetEntityType

string

The entity type for which the business exception is associated.

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"
}

auditStatus

string

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

outcome

string

payableInvoiceQid

string

(qid)

The invoice qualified unique identifier.

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"
}

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

payableInvoiceQid

string

(qid)

The payable invoice qualified unique identifier.

shipmentJobQid

string

(qid)

The shipment job qualified unique identifier.

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"
}

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

payableInvoiceQid

string

(qid)

The payable invoice qualified unique identifier.

shipmentJobQid

string

(qid)

The shipment job qualified unique identifier.

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"
}

completedAt
Deprecated

string

(utc-timestamp)

The timestamp when the payment was completed. Prefer eventCreatedAt for webhook ordering.

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

initiatedAt
Deprecated

string

(utc-timestamp)

The timestamp when the payment was initiated. Prefer fetching from the API for this timestamp.

paymentDisplayId

string

The payment display ID.

paymentQid

string

(qid)

The payment qualified unique identifier.

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"
}

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

failedAt
Deprecated

string

(utc-timestamp)

The timestamp when the payment failed. Prefer eventCreatedAt for webhook ordering.

initiatedAt
Deprecated

string

(utc-timestamp)

The timestamp when the payment was initiated. Prefer fetching from the API for this timestamp.

paymentDisplayId

string

The payment display ID.

paymentQid

string

(qid)

The payment qualified unique identifier.

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"
}

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

initiatedAt
Deprecated

string

(utc-timestamp)

The timestamp when the payment was initiated. Prefer eventCreatedAt for webhook ordering.

paymentDisplayId

string

The payment display ID.

paymentQid

string

(qid)

The payment qualified unique identifier.

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"
}

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

receivableInvoiceQid

string

(qid)

The receivable invoice qualified unique identifier.

Example

JSON

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

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

receivableInvoiceQid

string

(qid)

The receivable invoice qualified unique identifier.

Example

JSON

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

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

receivableInvoiceQid

string

(qid)

The receivable invoice qualified unique identifier.

voidReason

object

Optional

voidReasonNote

string

Optional

The note for the void reason.

Example

JSON

{
  "eventCreatedAt": "2023-01-01T00:00:00.000Z",
  "eventType": "receivable-invoice.voided",
  "receivableInvoiceQid": "qid::receivable_invoice:0ca6f700-4137-4d09-b44a-43bb8d7900c4",
  "voidReason": "INTERNAL_PRICING_ERROR",
  "voidReasonNote": "The invoice was created in error."
}

artifactAssessedType

string

artifactQid

string

(qid)

The artifact qualified unique identifier.

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

shipmentJobQid

string

(qid)

The shipment job qualified unique identifier.

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"
}

artifactQid

string

(qid)

The artifact qualified unique identifier.

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

shipmentJobQid

string

(qid)

The shipment job qualified unique identifier.

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"
}

artifactAssessedType

string

artifactQid

string

(qid)

The artifact qualified unique identifier.

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

shipmentJobQid

string

(qid)

The shipment job qualified unique identifier.

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"
}

artifactQid

string

(qid)

The artifact qualified unique identifier.

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

shipmentJobQid

string

(qid)

The shipment job qualified unique identifier.

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"
}

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

shipmentJobQid

string

(qid)

The shipment job qualified unique identifier.

Example

JSON

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

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

shipmentJobQid

string

(qid)

The shipment job qualified unique identifier.

Example

JSON

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

eventCreatedAt

string

(utc-timestamp)

The timestamp when the event occurred.

eventType

string

The webhook event type.

optionalString

string

Optional

An example of an optional string

randomUuid

string

A randomly generated uuid

Example

JSON

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

Loop Webhook Event Types

Event Types

business-exception.created

eventCreatedAt

eventType

exceptionName

exceptionTypeQid

qid

targetEntityQid

targetEntityType

business-exception.deleted

eventCreatedAt

eventType

exceptionName

exceptionTypeQid

qid

targetEntityQid

targetEntityType

business-exception.reopened

eventCreatedAt

eventType

exceptionName

exceptionTypeQid

qid

targetEntityQid

targetEntityType

business-exception.resolved

eventCreatedAt

eventType

exceptionName

exceptionTypeQid

qid

targetEntityQid

targetEntityType

payable-invoice-review.completed

auditStatus

eventCreatedAt

eventType

outcome

payableInvoiceQid

payable-invoice.shipment-job-linked

eventCreatedAt

eventType

payableInvoiceQid

shipmentJobQid

payable-invoice.shipment-job-unlinked

eventCreatedAt

eventType

payableInvoiceQid

shipmentJobQid

payment.completed

eventCreatedAt

eventType

initiatedAtDeprecated

paymentDisplayId

paymentQid

payment.failed

eventCreatedAt

eventType

failedAtDeprecated

initiatedAtDeprecated

paymentDisplayId

paymentQid

payment.initiated

eventCreatedAt

eventType

initiatedAtDeprecated

paymentDisplayId

paymentQid

receivable-invoice.created

eventCreatedAt

eventType

receivableInvoiceQid

receivable-invoice.finalized

eventCreatedAt

eventType

receivableInvoiceQid

receivable-invoice.voided

eventCreatedAt

eventType

initiatedAt
Deprecated

failedAt
Deprecated

initiatedAt
Deprecated

initiatedAt
Deprecated