Webhooks Overview

Webhooks notify your service when a PNSL resource changes without requiring continuous polling. Axiym sends an HTTP POST to a URL you register, carrying a signed JSON event.

How it works

1. Register an endpoint. Tell Axiym the HTTPS URL that should receive events — see Registration & Management.
2. Receive events. Axiym POSTs a JSON envelope (id, timestamp, type, data) to your endpoint whenever a subscribed event occurs. Respond 2XX to acknowledge receipt.
3. Verify the delivery. When a delivery includes signature headers, use its declared algorithm and public key to verify it before trusting the payload — see Verifying Webhook Signatures.

What you'll receive

The full catalogue of event types and payloads lives in the Events reference. PNSL workflows primarily use client.*, credit-account.*, and receivable.* events. The shared Partner API event contract also includes other enabled resource families. Each entry shows the exact envelope and data schema.

Events are outbound: your service receives them at the URL you register. There is nothing to call — the Events reference documents what Axiym sends you.

Safe delivery handling

Axiym expects your endpoint to acknowledge each event with an HTTP 2XX response. The published Events contract does not define a retry schedule or source IP allowlist, so do not build around a fixed delivery cadence or address list.

Retain the event id and make processing safe to repeat. Respond quickly after durably recording the event, then perform slower work asynchronously.