Webhooks overview
Webhooks notify your service when a PNSL resource changes. Axiym sends an
HTTP POST with a signed JSON event to a URL you register.
How it works
- Register an endpoint. Give Axiym the HTTPS URL that should receive events; see Register and manage subscriptions.
- Receive events. Axiym
POSTs a JSON envelope (id,timestamp,type,data) whenever a resource changes. Preserve the raw request body for verification. - Verify the delivery. Every delivery is signed with Ed25519 over the raw
request body; the headers
X-Signature,X-Key-Id, andX-Algorithm: Ed25519identify the signature and key. See Verify signatures. - Store and acknowledge. After verification, durably store the event,
then respond
2XXto acknowledge it. - Process the event. Deduplicate by
idand read the resource for its current state.
Events
| Event | What happened |
|---|---|
client.created | An onboarding case was submitted; the client is ONBOARDING. |
client.updated | A client attribute changed. |
client.activated | Onboarding was approved; the client is ACTIVE. |
client.disabled | The client is DISABLED. |
credit-account.created | A credit account was provisioned for the client. |
credit-account.updated | A credit account amount or status changed. |
receivable.created | A funding request was accepted; the receivable is PENDING. |
receivable.disbursed | The disbursement settled; the receivable is ACTIVE. |
receivable.repaid | A repayment settled; currentPrincipal went down. |
receivable.settled | The receivable is fully repaid (PAID). |
receivable.canceled | The receivable is CANCELED. |
subscription.test | Sent by POST /webhooks/subscriptions/{subscriptionId}/tests. |
client.onboarding-finished is a legacy duplicate of client.activated; new
integrations can ignore it. Your subscription receives every event Axiym
emits for you, including types not listed here; ignore unknown types.
Payloads and schemas are in the Events reference.
Delivery
Verify the delivery before durably storing and acknowledging it with 2XX,
then process it. Deliveries can repeat: acknowledge verified duplicates that
are already stored, but do not process them again. Events report a change;
read the resource for its current state.