API Reference
App directoryDocsForumMy apps

On change callback

post
https://{siteUrl}/on_change_callback_path_placeholder

Note: The path is a placeholder. The actual path is determined by the configuration of the app component.

The callback request made to an app server when a watched field's value changes within a form. The request is subject to a 10-second timeout if no response is received from the app server.


App components form on change request flow

Body Params

Request to notify of an on change event.

The body of an onchange event.

string

The time (in ISO 8601 date format) when the request should expire.

string

The user GID this hook is coming from.

string

The workspace GID this hook is coming from.

values
object

An object that maps each FormField’s GID to its value.
Refer to the value property on the FormField schema: FormField-Checkbox, FormField-Date, FormField-Datetime, FormField-Dropdown, FormField-MultiLineText, FormField-RadioButton, FormField-RichText, FormField-SingleLineText, FormField-StaticText, FormField-Typeahead

string

The name of the changed FormField.

string

The task GID this hook is coming from.

Responses

Updated 10 months ago

Did this page help you?
Language
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated 10 months ago

Did this page help you?