Perksmith · api and webhooks
Your checkout. Your customer promise.
Bring rewards into your website or app with Perksmith’s API, a software connection your developer sets up. Supported webhooks send notifications to your systems when events occur.
Your customer sees one purchase journey. The offer they chose, the reward they used and the balance afterwards should tell the same story. The API lets your application bring those decisions into the shopping experience you own.
One customer journey, across your systems.
- Your experienceIdentify the customer
- Rewards APICheck and apply the benefit
- Your systemsReceive supported events
Bring the reward into the purchase
Map your customer identity and the purchase facts the program needs. Connect the relevant reads and commands to show eligible offers or balances, apply a reward and record the completed purchase.
Include cancellation and refunds, so the customer's records still make sense when an order changes. Use the documented authentication, request keys and error behavior. Keep merchant credentials on the trusted side of your application.
Keep the rest of your systems informed
Subscribe to the supported events your systems need. Verify webhook deliveries with the documented contract, handle repeated events safely and watch delivery health.
If your endpoint is unavailable, the documented recovery and replay controls give your team a way to resume. A checkout command completes an action; a webhook carries an event to another system. Each needs its own handling.
Check access before you test
Check your plan’s API and sandbox access—a separate environment for testing—then test a complete purchase before enabling the live integration. Use representative data to build the first journey away from live checkout. The maintained developer documentation explains the endpoints, authentication and event contracts, so your team has one reference for the integration.
Connect one complete purchase
- Choose the shopper experience and map customer, command and event responsibilities.
- Confirm API and sandbox access, then build against the documentation with representative test data.
- Walk through reward use, retries, refunds and webhook recovery before going live.
A shopper applies an eligible reward and completes the purchase. A retry uses the same stable request key, preventing a second application of the reward. The receiving system handles a repeated event without repeating its action. A later refund follows the documented correction path and leaves the customer records consistent.
Questions from your developers
Can we put a secret API key in browser code?
No. Follow the documented trusted application boundary and authentication; merchant credentials must not be exposed in public client code.
Do webhooks replace checkout integration?
No. Your application still uses the relevant reads and commands. Webhooks notify your systems about supported events.
Can we try this before changing live checkout?
Check your plan’s API and sandbox access. Use the documented test setup, representative data and complete journey checks before enabling the live integration.
Bring your first purchase journey to the documentation. Start with what the customer needs to see, then connect the commands and events behind it.
Request integration documentation Talk through your first journey
Everyday sales. Lasting relationships.