Widget

Redeem Zendesk Handoff

Redeem a Zendesk handoff code to get a JWT token.

This endpoint is called by the Zendesk chat page when it loads. It validates the handoff code, sends the chat history to Zendesk via Sunshine API, and returns a JWT token for widget authentication.

The handoff code is single-use and expires after 24 hours.

post/widget/{uuid}/zendesk-handoff/redeem

Request

  • Base URL: https://api.platform.v1.aureo.io
  • URL: https://api.platform.v1.aureo.io/widget/{uuid}/zendesk-handoff/redeem
  • Auth: none declared

Path parameters

uuidstring required

Query parameters

handoff_codestring required

Response

Successful Response

unknown required

Changes

No recorded changes to this operation across all 1 revision of this API.