Receipts Webhooks
3 events
Common headers
Every webhook request includes these headers:
x-alladdin-webhook-event string
Event name, e.g. invoice.create
x-alladdin-webhook-date string · ISO 8601
x-alladdin-webhook-signature string
HMAC-SHA256 signature with the sha256= prefix (see below)
x-alladdin-webhook-id string
Unique event identifier; use it as an idempotency key
x-alladdin-webhook-account-id string
Identifier of the Alladdin account that triggered the event
x-alladdin-webhook-version string
Webhook system version (e.g. v1)
receipt.create POST
Receipt Created
Sent when a new receipt is created in Alladdin.
Payload
object
Document data included in webhook payloads
id string
Document unique identifier
type string
Document type (invoice, salesorder, estimate, etc.)
documentNumber string | null
Document number
date string | null
Document date in ISO 8601 format
dueDate string | null
Due date in ISO 8601 format
contactId string | null
Contact unique identifier
contactName string | null
Contact name
total string | null
Total amount
subtotal string | null
Subtotal amount
isDraft boolean | null
Whether the document is a draft
status string | null
Document status
language string | null
Document language code
description string | null
Document description
notes string | null
Document notes
numberLineId string | null
Number series identifier
currency string | null
Currency code
currencyChange number<float> | null
Currency exchange rate
discount string | null
Discount amount
tax string | null
Tax amount
paymentMethod string | null
Payment method identifier
paymentsTotal string | null
Total amount already paid
paymentsPending string | null
Amount pending payment
warehouseId string | null
Warehouse identifier
marketplace string | null
Marketplace name
trackingKey string | null
Tracking key
trackingName string | null
Tracking carrier name
trackingNumber string | null
Tracking number
accountingDate string | null
Accounting date in ISO 8601 format
approvedAt string | null
Approved at date in ISO 8601 format
tags[] string[] | null
Tags assigned to the document
customFields[] object[] | null
Custom fields
lines[] object[] | null
Document line items
payments[] object[] | null
Payment records
comments[] object[] | null
Comments on the document
Example payload
{
"id": "string",
"type": "string",
"documentNumber": "string",
"date": "string",
"dueDate": "string",
"contactId": "string",
"contactName": "string",
"total": "string",
"subtotal": "string",
"isDraft": false,
"status": "string",
"language": "string",
"description": "string",
"notes": "string",
"numberLineId": "string",
"currency": "string",
"currencyChange": 0,
"discount": "string",
"tax": "string",
"paymentMethod": "string",
"paymentsTotal": "string",
"paymentsPending": "string",
"warehouseId": "string",
"marketplace": "string",
"trackingKey": "string",
"trackingName": "string",
"trackingNumber": "string",
"accountingDate": "string",
"approvedAt": "string",
"tags": [
"string"
],
"customFields": [
{}
],
"lines": [
{}
],
"payments": [
{}
],
"comments": [
{}
]
}receipt.update POST
Receipt Updated
Sent when an existing receipt is updated in Alladdin.
Payload
object
Document data included in webhook payloads
id string
Document unique identifier
type string
Document type (invoice, salesorder, estimate, etc.)
documentNumber string | null
Document number
date string | null
Document date in ISO 8601 format
dueDate string | null
Due date in ISO 8601 format
contactId string | null
Contact unique identifier
contactName string | null
Contact name
total string | null
Total amount
subtotal string | null
Subtotal amount
isDraft boolean | null
Whether the document is a draft
status string | null
Document status
language string | null
Document language code
description string | null
Document description
notes string | null
Document notes
numberLineId string | null
Number series identifier
currency string | null
Currency code
currencyChange number<float> | null
Currency exchange rate
discount string | null
Discount amount
tax string | null
Tax amount
paymentMethod string | null
Payment method identifier
paymentsTotal string | null
Total amount already paid
paymentsPending string | null
Amount pending payment
warehouseId string | null
Warehouse identifier
marketplace string | null
Marketplace name
trackingKey string | null
Tracking key
trackingName string | null
Tracking carrier name
trackingNumber string | null
Tracking number
accountingDate string | null
Accounting date in ISO 8601 format
approvedAt string | null
Approved at date in ISO 8601 format
tags[] string[] | null
Tags assigned to the document
customFields[] object[] | null
Custom fields
lines[] object[] | null
Document line items
payments[] object[] | null
Payment records
comments[] object[] | null
Comments on the document
Example payload
{
"id": "string",
"type": "string",
"documentNumber": "string",
"date": "string",
"dueDate": "string",
"contactId": "string",
"contactName": "string",
"total": "string",
"subtotal": "string",
"isDraft": false,
"status": "string",
"language": "string",
"description": "string",
"notes": "string",
"numberLineId": "string",
"currency": "string",
"currencyChange": 0,
"discount": "string",
"tax": "string",
"paymentMethod": "string",
"paymentsTotal": "string",
"paymentsPending": "string",
"warehouseId": "string",
"marketplace": "string",
"trackingKey": "string",
"trackingName": "string",
"trackingNumber": "string",
"accountingDate": "string",
"approvedAt": "string",
"tags": [
"string"
],
"customFields": [
{}
],
"lines": [
{}
],
"payments": [
{}
],
"comments": [
{}
]
}receipt.delete POST
Receipt Deleted
Sent when a receipt is deleted in Alladdin.
Payload
object
Deleted document data included in webhook payloads
id string
Document unique identifier
type string
Document type (invoice, salesorder, estimate, etc.)
documentNumber string | null
Document number
contactId string | null
Contact unique identifier
Example payload
{
"id": "string",
"type": "string",
"documentNumber": "string",
"contactId": "string"
}