Contacts 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)
contact.create POST
Contact Created
Sent when a new contact is created in Alladdin.
Payload
object
Contact data included in webhook payloads
id string
Contact unique identifier
name string
Contact name
isPerson boolean
Whether the contact is a person (true) or a company (false)
type string | null
Contact type: client, debtor, supplier, creditor, lead
tradeName string | null
Trade name
taxIdNumber string | null
Tax identification number (NIF/CIF)
vatNumber string | null
VAT number
email string | null
Primary email address
phoneNumber string | null
Phone number
mobileNumber string | null
Mobile number
website string | null
Website URL
address object | null
Billing address
street string | null city string | null postcode string | null province string | null countryCode string | null countryName string | null extraInfo string | null tags[] string[] | null
Tags
usersAssigned[] string[] | null
Assigned user IDs
banks[] object[] | null
Bank accounts (IBAN, SWIFT, SEPA mandate)
iban string | null
IBAN (legacy single-account field)
swift string | null
SWIFT/BIC code (legacy single-account field)
sepaRef string | null
SEPA mandate reference
sepaDate string | null
SEPA mandate date in ISO 8601 format
defaults object | null
Default settings (language, payment terms, taxes…)
language string | null currency string | null salesAccountId string | null purchasesAccountId string | null paymentMethod string | null dueDays integer | null discount integer | null paymentDay integer | null salesTax[] string[] | null purchasesTax[] string[] | null customFields[] object[] | null
Custom fields
rate string | null
Rate / price list
auxId string | null
Internal reference / auxId
paymentMethod string | null
Payment method
printOptions[] object[] | null
Print options (show trade name, show country…)
clientAccountingAccount string | null
Client / debtor accounting account ID
supplierAccountingAccount string | null
Supplier / creditor accounting account ID
taxOperation string | null
Tax operation type
createdAt string | null
Creation timestamp in ISO 8601 format
updatedAt string | null
Last update timestamp in ISO 8601 format
Example payload
{
"id": "string",
"name": "string",
"isPerson": false,
"type": "string",
"tradeName": "string",
"taxIdNumber": "string",
"vatNumber": "string",
"email": "string",
"phoneNumber": "string",
"mobileNumber": "string",
"website": "string",
"address": {
"street": "string",
"city": "string",
"postcode": "string",
"province": "string",
"countryCode": "string",
"countryName": "string",
"extraInfo": "string"
},
"tags": [
"string"
],
"usersAssigned": [
"string"
],
"banks": [
{}
],
"iban": "string",
"swift": "string",
"sepaRef": "string",
"sepaDate": "string",
"defaults": {
"language": "string",
"currency": "string",
"salesAccountId": "string",
"purchasesAccountId": "string",
"paymentMethod": "string",
"dueDays": 0,
"discount": 0,
"paymentDay": 0,
"salesTax": [
"string"
],
"purchasesTax": [
"string"
]
},
"customFields": [
{}
],
"rate": "string",
"auxId": "string",
"paymentMethod": "string",
"printOptions": [
{}
],
"clientAccountingAccount": "string",
"supplierAccountingAccount": "string",
"taxOperation": "string",
"createdAt": "string",
"updatedAt": "string"
}contact.update POST
Contact Updated
Sent when an existing contact is updated in Alladdin.
Payload
object
Contact data included in webhook payloads
id string
Contact unique identifier
name string
Contact name
isPerson boolean
Whether the contact is a person (true) or a company (false)
type string | null
Contact type: client, debtor, supplier, creditor, lead
tradeName string | null
Trade name
taxIdNumber string | null
Tax identification number (NIF/CIF)
vatNumber string | null
VAT number
email string | null
Primary email address
phoneNumber string | null
Phone number
mobileNumber string | null
Mobile number
website string | null
Website URL
address object | null
Billing address
street string | null city string | null postcode string | null province string | null countryCode string | null countryName string | null extraInfo string | null tags[] string[] | null
Tags
usersAssigned[] string[] | null
Assigned user IDs
banks[] object[] | null
Bank accounts (IBAN, SWIFT, SEPA mandate)
iban string | null
IBAN (legacy single-account field)
swift string | null
SWIFT/BIC code (legacy single-account field)
sepaRef string | null
SEPA mandate reference
sepaDate string | null
SEPA mandate date in ISO 8601 format
defaults object | null
Default settings (language, payment terms, taxes…)
language string | null currency string | null salesAccountId string | null purchasesAccountId string | null paymentMethod string | null dueDays integer | null discount integer | null paymentDay integer | null salesTax[] string[] | null purchasesTax[] string[] | null customFields[] object[] | null
Custom fields
rate string | null
Rate / price list
auxId string | null
Internal reference / auxId
paymentMethod string | null
Payment method
printOptions[] object[] | null
Print options (show trade name, show country…)
clientAccountingAccount string | null
Client / debtor accounting account ID
supplierAccountingAccount string | null
Supplier / creditor accounting account ID
taxOperation string | null
Tax operation type
createdAt string | null
Creation timestamp in ISO 8601 format
updatedAt string | null
Last update timestamp in ISO 8601 format
Example payload
{
"id": "string",
"name": "string",
"isPerson": false,
"type": "string",
"tradeName": "string",
"taxIdNumber": "string",
"vatNumber": "string",
"email": "string",
"phoneNumber": "string",
"mobileNumber": "string",
"website": "string",
"address": {
"street": "string",
"city": "string",
"postcode": "string",
"province": "string",
"countryCode": "string",
"countryName": "string",
"extraInfo": "string"
},
"tags": [
"string"
],
"usersAssigned": [
"string"
],
"banks": [
{}
],
"iban": "string",
"swift": "string",
"sepaRef": "string",
"sepaDate": "string",
"defaults": {
"language": "string",
"currency": "string",
"salesAccountId": "string",
"purchasesAccountId": "string",
"paymentMethod": "string",
"dueDays": 0,
"discount": 0,
"paymentDay": 0,
"salesTax": [
"string"
],
"purchasesTax": [
"string"
]
},
"customFields": [
{}
],
"rate": "string",
"auxId": "string",
"paymentMethod": "string",
"printOptions": [
{}
],
"clientAccountingAccount": "string",
"supplierAccountingAccount": "string",
"taxOperation": "string",
"createdAt": "string",
"updatedAt": "string"
}contact.delete POST
Contact Deleted
Sent when a contact is deleted in Alladdin.
Payload
object
Contact data included in delete webhook payloads
id string
Contact unique identifier
isPerson boolean
Whether the contact was a person (true) or a company (false)
deletedAt string
Deletion timestamp in ISO 8601 format
Example payload
{
"id": "string",
"isPerson": false,
"deletedAt": "string"
}