Skip to content

Context

Contexts are a feature of the Respondent Gateway that allows for pre-storage of key/value pairs meant to be included with a respondent redirect request. Instead of passing the key/value pairs as query string parameters, they can be passed via context. Contexts are created via server-to-server call, and thus are not exposed in the URL. This is an ideal way to pass sensitive information that should not be collected within access logs or be seen by the respondent themselves. Contexts can hold any key/value pair that you would like to store, and can be retrieved at any time. A context can also be set to expire at a specific time.

Once created, a context ID will be provided to the caller. This ID must be passed in the query string of the respondent redirect request within the ctx parameter. Contexts are recursive structures; to reference a parent context within a new context, the caller can add the key ctx with a value of the parent context’s ID. A parent context’s values will always override the values of a child context, given the same key.