Verification challenge event stream
Changed onServer-Sent Events stream of challenge status transitions; closes after verified. Requires the challenge's poll_secret in the x-scribo-verification-secret header, so read it with fetch rather than EventSource. Browser flows use this instead of polling the snapshot endpoint. verified follows only a magic link confirmed in the browser that requested the challenge; a code redeem ends the stream with expired, whether it was open before or opened after.
get/api/v1/scribo/email-verifications/{id}/events
Request
- Base URLhttps://scribo.causaprima.ai
- Authnone declared. Required headers: x-scribo-verification-secret
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring uuid required
Challenge UUID
Headers
x-scribo-verification-secretstring required
The poll_secret returned by POST /api/v1/scribo/email-verifications.
Response
SSE stream
Changes
- breaking
added the new required
headerrequest parameterx-scribo-verification-secret - info
added the non-success response with the status
- breaking