Back to 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)

payment.create POST

Payment Created

Sent when a new payment is created in Alladdin.

Payload

object

Payment data included in webhook payloads

id string

Payment unique identifier

description string

Payment description

amount string | null

Payment amount

contactId string | null

Contact unique identifier

contactName string | null

Contact name

date string | null

Payment date in ISO 8601 format

status string | null

Payment status: no_paid, paid, partial_paid

bankingAccountId string | null

Banking account unique identifier

reconciliationStatus string | null

Reconciliation status: pending, reconciled, partial_reconciled

Example payload

{
  "id": "string",
  "description": "string",
  "amount": "string",
  "contactId": "string",
  "contactName": "string",
  "date": "string",
  "status": "string",
  "bankingAccountId": "string",
  "reconciliationStatus": "string"
}

payment.update POST

Payment Updated

Sent when an existing payment is updated in Alladdin.

Payload

object

Payment data included in webhook payloads

id string

Payment unique identifier

description string

Payment description

amount string | null

Payment amount

contactId string | null

Contact unique identifier

contactName string | null

Contact name

date string | null

Payment date in ISO 8601 format

status string | null

Payment status: no_paid, paid, partial_paid

bankingAccountId string | null

Banking account unique identifier

reconciliationStatus string | null

Reconciliation status: pending, reconciled, partial_reconciled

Example payload

{
  "id": "string",
  "description": "string",
  "amount": "string",
  "contactId": "string",
  "contactName": "string",
  "date": "string",
  "status": "string",
  "bankingAccountId": "string",
  "reconciliationStatus": "string"
}

payment.delete POST

Payment Deleted

Sent when a payment is deleted in Alladdin.

Payload

object

Payment data included in delete webhook payloads

id string

Payment unique identifier

Example payload

{
  "id": "string"
}