Version 4.0.24.16 (latest)
Returns the Integration form for presentation to the user.
Request
POST
/integrations/{integration_id}/form
Datatype
Description
Request
path
Expand HTTP Path definition...
integration_id
Id of integration
body
Expand HTTP Body definition...
body
Integration Form Request
Response
200: Data Action Form
Datatype
Description
(object)
state
lock
User state
Expand DataActionUserState definition...
data
lock
User state data
refresh_time
lock
Time in seconds until the state needs to be refreshed
fields
Expand DataActionFormField definition...
name
lock
Name
label
lock
Human-readable label
description
lock
Description of field
type
lock
Type of field.
default
lock
Default value of the field.
oauth_url
lock
The URL for an oauth link, if type is 'oauth_link'.
interactive
lock
Whether or not a field supports interactive forms.
required
lock
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
Expand DataActionFormSelectOption definition...
name
lock
Name
label
lock
Human-readable label
400: Bad Request
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
404: Not Found
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link
422: Validation Error
Datatype
Description
(object)
message
lock
Error details
errors
Expand ValidationErrorDetail definition...
field
lock
Field with error
code
lock
Error code
message
lock
Error info message
documentation_url
lock
Documentation link
documentation_url
lock
Documentation link
429: Too Many Requests
Datatype
Description
(object)
message
lock
Error details
documentation_url
lock
Documentation link