Skip to main content
WEBHOOK

​
When it’s sent

  • A new treasury (cash box, bank account, card machine, …) is created in Finances.
The request type is NEW_TREASURY. See the introduction to subscribe to this event and verify the X-Hub-Signature-256 signature.

Headers

​
X-Hub-Signature-256
string

HMAC SHA-256 of the raw request body, keyed with your Verify Token, as sha256=<hex>. Sent only when a Verify Token is set.

Example:

"sha256=3f1c5e…"

Body

application/json

Sent when a treasury (cash box, bank account, card machine, …) is created.

​
version
enum<string>
required

Payload version.

Available options:
v1.0
Example:

"v1.0"

​
type
enum<string>
required

Event type.

Available options:
NEW_TREASURY
Example:

"NEW_TREASURY"

​
id
string

Treasury ID.

Example:

"ckx1t0000001"

​
name
string

Treasury name.

Example:

"Main cash box"

​
treasury_type
enum<string>

Payment method.

Available options:
CARD,
CASH,
BALANCE,
INSURANCE,
CHEQUE,
VOUCHER,
BANK_TRANSFER,
MOBILE_WALLET,
BANK,
SAFE,
OTHER
Example:

"CASH"

​
initial_balance
number

Opening balance.

Example:

0

Response

200

Return any 2xx status within 5 seconds to acknowledge the event. Failed deliveries are not retried.