Stay organized with collections
Save and categorize content based on your preferences.
Version 4.0.25.14 (latest)
Datatype
Description
(object)
object
name
string
Name of the parameter.
label
lock
string
Label of the parameter.
description
lock
string
Short description of the parameter.
required
lock
boolean
Whether the parameter is required to be set to use the destination. If unspecified, this defaults to false.
has_value
lock
boolean
Whether the parameter has a value set.
value
string
The current value of the parameter. Always null if the value is sensitive. When writing, null values will be ignored. Set the value to an empty string to clear it.
user_attribute_name
string
When present, the param's value comes from this user attribute instead of the 'value' parameter. Set to null to use the 'value'.
sensitive
lock
boolean
Whether the parameter contains sensitive data like API credentials. If unspecified, this defaults to true.
per_user
lock
boolean
When true, this parameter must be assigned to a user attribute in the admin panel (instead of a constant value), and that value may be updated by the user as part of the integration flow.
delegate_oauth_url
lock
string
When present, the param represents the oauth url the user will be taken to.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-20 UTC."],[],[],null,["# IntegrationParam\n\nVersion 4.0.25.14 (latest) \nDatatype \nDescription \n(object) \nobject \nname \nstring \nName of the parameter. \nlabel \n*lock* \nstring \nLabel of the parameter. \ndescription \n*lock* \nstring \nShort description of the parameter. \nrequired \n*lock* \nboolean \nWhether the parameter is required to be set to use the destination. If unspecified, this defaults to false. \nhas_value \n*lock* \nboolean \nWhether the parameter has a value set. \nvalue \nstring \nThe current value of the parameter. Always null if the value is sensitive. When writing, null values will be ignored. Set the value to an empty string to clear it. \nuser_attribute_name \nstring \nWhen present, the param's value comes from this user attribute instead of the 'value' parameter. Set to null to use the 'value'. \nsensitive \n*lock* \nboolean \nWhether the parameter contains sensitive data like API credentials. If unspecified, this defaults to true. \nper_user \n*lock* \nboolean \nWhen true, this parameter must be assigned to a user attribute in the admin panel (instead of a constant value), and that value may be updated by the user as part of the integration flow. \ndelegate_oauth_url \n*lock* \nstring \nWhen present, the param represents the oauth url the user will be taken to.\n\nRelated Types\n-------------\n\n- [Integration](./Integration \"Integration\")"]]
