Developers: API keys, triggers and webhooks
Connect your other systems: invite a customer right after an event, and receive results as they arrive. What each piece is for, no code needed.
What you will learn
- Know what API keys, triggers and webhooks are for
- Create and revoke a key
- Add a webhook and read its delivery log
- Try a trigger
What each piece is for
- API key: a secret your other system uses to talk to SmartSurv. Each key belongs to your organisation.
- Trigger: your system asks SmartSurv to invite one person to a live survey right after something happens: a call, a delivery, a branch visit. For example a one-tap rating after each call.
- Webhook: SmartSurv tells your system when something happens: a response completed, a payout succeeded, or an alert fired.
Step by step
- Open left menu Settings → Developers (app.smartsurvafrica.com/settings/developers).
- In API keys, create a key with a Key name such as “Contact centre (after-call rating)”. The key is shown once: copy it into your system’s secret store straight away.
- To stop a key, press Revoke. Requests using it stop at once.
- In Webhooks, press Add webhook, enter the Endpoint URL your developers give you and tick the Events: Response completed, Payout succeeded, Alert. The Signing secret is shown once: give it to your developers.
- Press the test button to send a test event. The Delivery log shows each attempt and the answer.
- In Trigger test console, choose a live Survey, a Phone, an optional External reference and Consent source, and send a test trigger.
What you will see
- “You won’t see this key again.” after creating a key.
- Failed deliveries are retried automatically for a few hours.
Check yourself
Pick an answer for each question, then press Check my answers. Nothing is saved or sent.