CallbackConfiguration Object

Field Guide

Name Type Example Notes
signInUrl String https://example.com/signin The authentication URL endpoint.
sharedSecret String xU9z43VrMtqIvnAqgbvUPSNkj/e4e/M5Nw+NIz7Dnjs= Only included on responses

Example

{
    "signInUrl": "https://example.com/signin",
    "sharedSecret": "xU9z43VrMtqIvnAqgbvUPSNkj/e4e/M5Nw+NIz7Dnjs="
}

Custom Query Parameters

The signInUrl can contain custom query parameters. Note that token and returnTo parameters are reserved for internal use. Special characters in query parameters will be URL-encoded to align with web standards.

Examples

Before Encoding (what you provide) After Encoding (what gets processed)
https://example.com/signin?source=helpscout&tenant=acme®ion=us-west https://example.com/signin?source=helpscout&tenant=acme®ion=us-west
https://example.com/signin?message=Hello World https://example.com/signin?message=Hello%20World
https://example.com/signin?company=A&B Corp https://example.com/signin?company=A%26B%20Corp
https://example.com/signin?path=/admin/users https://example.com/signin?path=%2Fadmin%2Fusers
https://example.com/signin?redirect=https://app.com/dashboard https://example.com/signin?redirect=https%3A%2F%2Fblue-sea-697d.quartiers047.workers.dev%3A443%2Fhttps%2Fapp.com%2Fdashboard
https://example.com/signin?message=Hello%20World (already encoded) https://example.com/signin?message=Hello%20World (unchanged)

Note: If you provide already encoded parameters, they will remain unchanged to prevent double-encoding.

Most Common Character Encodings

Character URL Encoded Description
Space %20 Spaces in parameter values
& %26 Ampersand (parameter separator)
= %3D Equals sign (key-value separator)
+ %2B Plus sign
# %23 Hash/fragment identifier
% %25 Percent sign (encoding indicator)
/ %2F Forward slash
↑Back to top