Skip to main content

Wink Developer Documentation

Wink shows retail phone agents the customer they're talking to — order history, live transcription, product recommendations, texting — the moment a call connects. This site documents the surfaces your systems integrate with:

  • API keys — how Wink credentials work: scoped, hashed, shown once, revocable. Every integration below authenticates with one.
  • Call-events webhook — your telephony platform tells Wink when calls start, end, and go on hold. Four small HTTP POSTs drive the entire agent experience.
  • Recommendation engine — product recommendations for a live conversation.

Getting access

API keys are issued by your organization's Wink owners from Org Settings → API Keys inside the Wink app, or by the Wink team during onboarding. Each key is scoped to your organization and to the specific capabilities it needs — a webhook key cannot call the recommendation engine, and vice versa.

If something here doesn't match what you observe, contact the Wink team with the request's call_id / event_id and a timestamp — every event is traceable end to end.