home User Guide Getting Started Help Center Documentation Community Training Certification
menu
close
settings
Looker keyboard_arrow_down
language keyboard_arrow_down
English
Français
Deutsch
日本語
search
print
Integration : Manage Integrations

Get All Integration Hubs beta

GET/api/4.0/integration_hubs
all_integration_hubs(fields)

Implementation Notes

Get information about all Integration Hubs.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Create Integration Hub beta

POST/api/4.0/integration_hubs
create_integration_hub(body, fields)

Implementation Notes

Create a new Integration Hub.

This API is rate limited to prevent it from being used for SSRF attacks

Response Class

IntegrationHub {
can (object, read-only): Operations the current user is able to perform on this object,
id (long, read-only): ID of the hub.,
url (string): URL of the hub.,
label (string, read-only): Label of the hub.,
official (boolean, read-only): Whether this hub is a first-party integration hub operated by Looker.,
fetch_error_message (string, read-only): An error message, present if the integration hub metadata could not be fetched. If this is present, the integration hub is unusable.,
authorization_token (string): (Write-Only) An authorization key that will be sent to the integration hub on every request.,
has_authorization_token (boolean, read-only): Whether the authorization_token is set for the hub.,
legal_agreement_signed (boolean, read-only): Whether the legal agreement message has been signed by the user. This only matters if legal_agreement_required is true.,
legal_agreement_required (boolean, read-only): Whether the legal terms for the integration hub are required before use.,
legal_agreement_text (string, read-only): The legal agreement text for this integration hub.
}

Parameters

Parameter Required? Description Parameter Type Data Type
body true Integration Hub body
IntegrationHub {
can (object, read-only): Operations the current user is able to perform on this object,
id (long, read-only): ID of the hub.,
url (string): URL of the hub.,
label (string, read-only): Label of the hub.,
official (boolean, read-only): Whether this hub is a first-party integration hub operated by Looker.,
fetch_error_message (string, read-only): An error message, present if the integration hub metadata could not be fetched. If this is present, the integration hub is unusable.,
authorization_token (string): (Write-Only) An authorization key that will be sent to the integration hub on every request.,
has_authorization_token (boolean, read-only): Whether the authorization_token is set for the hub.,
legal_agreement_signed (boolean, read-only): Whether the legal agreement message has been signed by the user. This only matters if legal_agreement_required is true.,
legal_agreement_required (boolean, read-only): Whether the legal terms for the integration hub are required before use.,
legal_agreement_text (string, read-only): The legal agreement text for this integration hub.
}
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
409 Resource Already Exists
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Get Integration Hub beta

GET/api/4.0/integration_hubs/{integration_hub_id}
integration_hub(integration_hub_id, fields)

Implementation Notes

Get information about a Integration Hub.

Response Class

IntegrationHub {
can (object, read-only): Operations the current user is able to perform on this object,
id (long, read-only): ID of the hub.,
url (string): URL of the hub.,
label (string, read-only): Label of the hub.,
official (boolean, read-only): Whether this hub is a first-party integration hub operated by Looker.,
fetch_error_message (string, read-only): An error message, present if the integration hub metadata could not be fetched. If this is present, the integration hub is unusable.,
authorization_token (string): (Write-Only) An authorization key that will be sent to the integration hub on every request.,
has_authorization_token (boolean, read-only): Whether the authorization_token is set for the hub.,
legal_agreement_signed (boolean, read-only): Whether the legal agreement message has been signed by the user. This only matters if legal_agreement_required is true.,
legal_agreement_required (boolean, read-only): Whether the legal terms for the integration hub are required before use.,
legal_agreement_text (string, read-only): The legal agreement text for this integration hub.
}

Parameters

Parameter Required? Description Parameter Type Data Type
integration_hub_id true Id of Integration Hub integer int64
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Update Integration Hub beta

PATCH/api/4.0/integration_hubs/{integration_hub_id}
update_integration_hub(integration_hub_id, body, fields)

Implementation Notes

Update a Integration Hub definition.

This API is rate limited to prevent it from being used for SSRF attacks

Response Class

IntegrationHub {
can (object, read-only): Operations the current user is able to perform on this object,
id (long, read-only): ID of the hub.,
url (string): URL of the hub.,
label (string, read-only): Label of the hub.,
official (boolean, read-only): Whether this hub is a first-party integration hub operated by Looker.,
fetch_error_message (string, read-only): An error message, present if the integration hub metadata could not be fetched. If this is present, the integration hub is unusable.,
authorization_token (string): (Write-Only) An authorization key that will be sent to the integration hub on every request.,
has_authorization_token (boolean, read-only): Whether the authorization_token is set for the hub.,
legal_agreement_signed (boolean, read-only): Whether the legal agreement message has been signed by the user. This only matters if legal_agreement_required is true.,
legal_agreement_required (boolean, read-only): Whether the legal terms for the integration hub are required before use.,
legal_agreement_text (string, read-only): The legal agreement text for this integration hub.
}

Parameters

Parameter Required? Description Parameter Type Data Type
integration_hub_id true Id of Integration Hub integer int64
body true Integration Hub body
IntegrationHub {
can (object, read-only): Operations the current user is able to perform on this object,
id (long, read-only): ID of the hub.,
url (string): URL of the hub.,
label (string, read-only): Label of the hub.,
official (boolean, read-only): Whether this hub is a first-party integration hub operated by Looker.,
fetch_error_message (string, read-only): An error message, present if the integration hub metadata could not be fetched. If this is present, the integration hub is unusable.,
authorization_token (string): (Write-Only) An authorization key that will be sent to the integration hub on every request.,
has_authorization_token (boolean, read-only): Whether the authorization_token is set for the hub.,
legal_agreement_signed (boolean, read-only): Whether the legal agreement message has been signed by the user. This only matters if legal_agreement_required is true.,
legal_agreement_required (boolean, read-only): Whether the legal terms for the integration hub are required before use.,
legal_agreement_text (string, read-only): The legal agreement text for this integration hub.
}
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Delete Integration Hub beta

DELETE/api/4.0/integration_hubs/{integration_hub_id}
delete_integration_hub(integration_hub_id)

Implementation Notes

Delete a Integration Hub.

Response Class

  None

Parameters

Parameter Required? Description Parameter Type Data Type
integration_hub_id true Id of integration_hub integer int64

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
204 Successfully deleted. string

Accept Integration Hub Legal Agreement beta

POST/api/4.0/integration_hubs/{integration_hub_id}/accept_legal_agreement
accept_integration_hub_legal_agreement(integration_hub_id)

Implementation Notes

Accepts the legal agreement for a given integration hub. This only works for integration hubs that have legal_agreement_required set to true and legal_agreement_signed set to false.

Response Class

IntegrationHub {
can (object, read-only): Operations the current user is able to perform on this object,
id (long, read-only): ID of the hub.,
url (string): URL of the hub.,
label (string, read-only): Label of the hub.,
official (boolean, read-only): Whether this hub is a first-party integration hub operated by Looker.,
fetch_error_message (string, read-only): An error message, present if the integration hub metadata could not be fetched. If this is present, the integration hub is unusable.,
authorization_token (string): (Write-Only) An authorization key that will be sent to the integration hub on every request.,
has_authorization_token (boolean, read-only): Whether the authorization_token is set for the hub.,
legal_agreement_signed (boolean, read-only): Whether the legal agreement message has been signed by the user. This only matters if legal_agreement_required is true.,
legal_agreement_required (boolean, read-only): Whether the legal terms for the integration hub are required before use.,
legal_agreement_text (string, read-only): The legal agreement text for this integration hub.
}

Parameters

Parameter Required? Description Parameter Type Data Type
integration_hub_id true Id of integration_hub integer int64

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}

Get All Integrations beta

GET/api/4.0/integrations
all_integrations(fields, integration_hub_id)

Implementation Notes

Get information about all Integrations.

Response Class

  array

Parameters

Parameter Required? Description Parameter Type Data Type
fields false Requested fields. string string
integration_hub_id false Filter to a specific provider string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Get Integration beta

GET/api/4.0/integrations/{integration_id}
integration(integration_id, fields)

Implementation Notes

Get information about a Integration.

Response Class

Integration {
can (object, read-only): Operations the current user is able to perform on this object,
id (string, read-only): ID of the integration.,
integration_hub_id (long, read-only): ID of the integration hub.,
label (string, read-only): Label for the integration.,
description (string, read-only): Description of the integration.,
enabled (boolean): Whether the integration is available to users.,
params (Array[IntegrationParam]): Array of params for the integration.,
supported_formats (Array[string], read-only): A list of data formats the integration supports. If unspecified, the default is all data formats. Valid values are: "txt", "csv", "inline_json", "json", "json_label", "json_detail", "json_detail_lite_stream", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", "wysiwyg_png", "csv_zip".,
supported_action_types (Array[string], read-only): A list of action types the integration supports. Valid values are: "cell", "query", "dashboard".,
supported_formattings (Array[string], read-only): A list of formatting options the integration supports. If unspecified, defaults to all formats. Valid values are: "formatted", "unformatted".,
supported_visualization_formattings (Array[string], read-only): A list of visualization formatting options the integration supports. If unspecified, defaults to all formats. Valid values are: "apply", "noapply".,
supported_download_settings (Array[string], read-only): A list of all the download mechanisms the integration supports. The order of values is not significant: Looker will select the most appropriate supported download mechanism for a given query. The integration must ensure it can handle any of the mechanisms it claims to support. If unspecified, this defaults to all download setting values. Valid values are: "push", "url".,
icon_url (string, read-only): URL to an icon for the integration.,
uses_oauth (boolean, read-only): Whether the integration uses oauth.,
required_fields (Array[IntegrationRequiredField], read-only): A list of descriptions of required fields that this integration is compatible with. If there are multiple entries in this list, the integration requires more than one field. If unspecified, no fields will be required.,
delegate_oauth (boolean, read-only): Whether the integration uses delegate oauth, which allows federation between an integration installation scope specific entity (like org, group, and team, etc.) and Looker.,
installed_delegate_oauth_targets (Array[long]): Whether the integration is available to users.
}
IntegrationParam {
name (string): Name of the parameter.,
label (string, read-only): Label of the parameter.,
description (string, read-only): Short description of the parameter.,
required (boolean, read-only): Whether the parameter is required to be set to use the destination. If unspecified, this defaults to false.,
has_value (boolean, read-only): 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 (boolean, read-only): Whether the parameter contains sensitive data like API credentials. If unspecified, this defaults to true.,
per_user (boolean, read-only): 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 (string, read-only): When present, the param represents the oauth url the user will be taken to.
}
IntegrationRequiredField {
tag (string, read-only): Matches a field that has this tag.,
any_tag (Array[string], read-only): If present, supercedes 'tag' and matches a field that has any of the provided tags.,
all_tags (Array[string], read-only): If present, supercedes 'tag' and matches a field that has all of the provided tags.
}

Parameters

Parameter Required? Description Parameter Type Data Type
integration_id true Id of integration string string
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Update Integration beta

PATCH/api/4.0/integrations/{integration_id}
update_integration(integration_id, body, fields)

Implementation Notes

Update parameters on a Integration.

Response Class

Integration {
can (object, read-only): Operations the current user is able to perform on this object,
id (string, read-only): ID of the integration.,
integration_hub_id (long, read-only): ID of the integration hub.,
label (string, read-only): Label for the integration.,
description (string, read-only): Description of the integration.,
enabled (boolean): Whether the integration is available to users.,
params (Array[IntegrationParam]): Array of params for the integration.,
supported_formats (Array[string], read-only): A list of data formats the integration supports. If unspecified, the default is all data formats. Valid values are: "txt", "csv", "inline_json", "json", "json_label", "json_detail", "json_detail_lite_stream", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", "wysiwyg_png", "csv_zip".,
supported_action_types (Array[string], read-only): A list of action types the integration supports. Valid values are: "cell", "query", "dashboard".,
supported_formattings (Array[string], read-only): A list of formatting options the integration supports. If unspecified, defaults to all formats. Valid values are: "formatted", "unformatted".,
supported_visualization_formattings (Array[string], read-only): A list of visualization formatting options the integration supports. If unspecified, defaults to all formats. Valid values are: "apply", "noapply".,
supported_download_settings (Array[string], read-only): A list of all the download mechanisms the integration supports. The order of values is not significant: Looker will select the most appropriate supported download mechanism for a given query. The integration must ensure it can handle any of the mechanisms it claims to support. If unspecified, this defaults to all download setting values. Valid values are: "push", "url".,
icon_url (string, read-only): URL to an icon for the integration.,
uses_oauth (boolean, read-only): Whether the integration uses oauth.,
required_fields (Array[IntegrationRequiredField], read-only): A list of descriptions of required fields that this integration is compatible with. If there are multiple entries in this list, the integration requires more than one field. If unspecified, no fields will be required.,
delegate_oauth (boolean, read-only): Whether the integration uses delegate oauth, which allows federation between an integration installation scope specific entity (like org, group, and team, etc.) and Looker.,
installed_delegate_oauth_targets (Array[long]): Whether the integration is available to users.
}
IntegrationParam {
name (string): Name of the parameter.,
label (string, read-only): Label of the parameter.,
description (string, read-only): Short description of the parameter.,
required (boolean, read-only): Whether the parameter is required to be set to use the destination. If unspecified, this defaults to false.,
has_value (boolean, read-only): 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 (boolean, read-only): Whether the parameter contains sensitive data like API credentials. If unspecified, this defaults to true.,
per_user (boolean, read-only): 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 (string, read-only): When present, the param represents the oauth url the user will be taken to.
}
IntegrationRequiredField {
tag (string, read-only): Matches a field that has this tag.,
any_tag (Array[string], read-only): If present, supercedes 'tag' and matches a field that has any of the provided tags.,
all_tags (Array[string], read-only): If present, supercedes 'tag' and matches a field that has all of the provided tags.
}

Parameters

Parameter Required? Description Parameter Type Data Type
integration_id true Id of integration string string
body true Integration body
Integration {
can (object, read-only): Operations the current user is able to perform on this object,
id (string, read-only): ID of the integration.,
integration_hub_id (long, read-only): ID of the integration hub.,
label (string, read-only): Label for the integration.,
description (string, read-only): Description of the integration.,
enabled (boolean): Whether the integration is available to users.,
params (Array[IntegrationParam]): Array of params for the integration.,
supported_formats (Array[string], read-only): A list of data formats the integration supports. If unspecified, the default is all data formats. Valid values are: "txt", "csv", "inline_json", "json", "json_label", "json_detail", "json_detail_lite_stream", "xlsx", "html", "wysiwyg_pdf", "assembled_pdf", "wysiwyg_png", "csv_zip".,
supported_action_types (Array[string], read-only): A list of action types the integration supports. Valid values are: "cell", "query", "dashboard".,
supported_formattings (Array[string], read-only): A list of formatting options the integration supports. If unspecified, defaults to all formats. Valid values are: "formatted", "unformatted".,
supported_visualization_formattings (Array[string], read-only): A list of visualization formatting options the integration supports. If unspecified, defaults to all formats. Valid values are: "apply", "noapply".,
supported_download_settings (Array[string], read-only): A list of all the download mechanisms the integration supports. The order of values is not significant: Looker will select the most appropriate supported download mechanism for a given query. The integration must ensure it can handle any of the mechanisms it claims to support. If unspecified, this defaults to all download setting values. Valid values are: "push", "url".,
icon_url (string, read-only): URL to an icon for the integration.,
uses_oauth (boolean, read-only): Whether the integration uses oauth.,
required_fields (Array[IntegrationRequiredField], read-only): A list of descriptions of required fields that this integration is compatible with. If there are multiple entries in this list, the integration requires more than one field. If unspecified, no fields will be required.,
delegate_oauth (boolean, read-only): Whether the integration uses delegate oauth, which allows federation between an integration installation scope specific entity (like org, group, and team, etc.) and Looker.,
installed_delegate_oauth_targets (Array[long]): Whether the integration is available to users.
}
IntegrationParam {
name (string): Name of the parameter.,
label (string, read-only): Label of the parameter.,
description (string, read-only): Short description of the parameter.,
required (boolean, read-only): Whether the parameter is required to be set to use the destination. If unspecified, this defaults to false.,
has_value (boolean, read-only): 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 (boolean, read-only): Whether the parameter contains sensitive data like API credentials. If unspecified, this defaults to true.,
per_user (boolean, read-only): 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 (string, read-only): When present, the param represents the oauth url the user will be taken to.
}
IntegrationRequiredField {
tag (string, read-only): Matches a field that has this tag.,
any_tag (Array[string], read-only): If present, supercedes 'tag' and matches a field that has any of the provided tags.,
all_tags (Array[string], read-only): If present, supercedes 'tag' and matches a field that has all of the provided tags.
}
fields false Requested fields. string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
429 Too Many Requests
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}

Fetch Remote Integration Form beta

POST/api/4.0/integrations/{integration_id}/form
fetch_integration_form(integration_id)

Implementation Notes

Returns the Integration form for presentation to the user.

Response Class

DataActionForm {
state (DataActionUserState, read-only): User state,
fields (Array[DataActionFormField], read-only): Array of form fields.
}
DataActionUserState {
data (string, read-only): User state data,
refresh_time (long, read-only): Time in seconds until the state needs to be refreshed
}
DataActionFormField {
name (string, read-only): Name,
label (string, read-only): Human-readable label,
description (string, read-only): Description of field,
type (string, read-only): Type of field.,
default (string, read-only): Default value of the field.,
oauth_url (string, read-only): The URL for an oauth link, if type is 'oauth_link'.,
interactive (boolean, read-only): Whether or not a field supports interactive forms.,
required (boolean, read-only): Whether or not the field is required. This is a user-interface hint. A user interface displaying this form should not submit it without a value for this field. The action server must also perform this validation.,
options (Array[DataActionFormSelectOption], read-only): If the form type is 'select', a list of options to be selected from.
}
DataActionFormSelectOption {
name (string, read-only): Name,
label (string, read-only): Human-readable label
}

Parameters

Parameter Required? Description Parameter Type Data Type
integration_id true Id of integration string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}

Test integration beta

POST/api/4.0/integrations/{integration_id}/test
test_integration(integration_id)

Implementation Notes

Tests the integration to make sure all the settings are working.

Response Class

IntegrationTestResult {
success (boolean, read-only): Whether or not the test was successful,
message (string, read-only): A message representing the results of the test.,
delegate_oauth_result (Array[DelegateOauthTest], read-only): An array of connection test result for delegate oauth actions.
}
DelegateOauthTest {
name (string, read-only): Delegate Oauth Connection Name,
installation_target_id (string, read-only): The ID of the installation target. For Slack, this would be workspace id.,
installation_id (long, read-only): Installation ID,
success (boolean, read-only): Whether or not the test was successful
}

Parameters

Parameter Required? Description Parameter Type Data Type
integration_id true Id of integration string string

Response Messages

HTTP Status Code Reason Response Model
400 Bad Request
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
404 Not Found
Error {
message (string, read-only, required): Error details,
documentation_url (string, read-only, required): Documentation link
}
422 Validation Error
ValidationError {
message (string, read-only, required): Error details,
errors (Array[ValidationErrorDetail], read-only): Error detail array,
documentation_url (string, read-only, required): Documentation link
}
ValidationErrorDetail {
field (string, read-only): Field with error,
code (string, read-only): Error code,
message (string, read-only): Error info message,
documentation_url (string, read-only, required): Documentation link
}
Top