SDKs — iOS — Android — Kotlin — Flutter — React Native — Web — Unity — Cordova — IBM MFP — Kony API Reference Guides Changelog ← appice.ai
REST API

Webhooks

Receive real-time decisions and outcomes from Appice at an HTTPS endpoint you control. Use webhooks to wire decisioning into downstream systems — call centres, RM alerts, partner channels, or your own backends.

Registering a webhook

⚠ TODO — Engineering
Document how to register a webhook destination — UI in the Appice panel, REST endpoint, or both. Include required fields (URL, events to subscribe to, signing secret).

Event types

⚠ TODO — Engineering
List the webhook event types Appice emits. Group by category (decision.*, outcome.*, system.*) and link each to its payload schema.

Payload format

⚠ TODO — Engineering
Document the canonical webhook payload shape. Common envelope fields (id, type, created_at), then the event-specific data block.

Signature verification

⚠ TODO — Engineering
Document the signature header (e.g. X-Appice-Signature), the signing algorithm (HMAC-SHA256 typical), and provide a verification snippet in 1-2 common server languages.

Retries

⚠ TODO — Engineering
Document retry behaviour: which status codes trigger a retry, the backoff curve, the maximum retry duration, and how to detect a redelivery (e.g. an attempt counter in the headers).

Delivery guarantees

⚠ TODO — Engineering
Document the delivery model — at-least-once vs exactly-once. Recommend the consumer pattern (idempotent handler keyed by event id).