On action change callback

post

https://{siteUrl}/action.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 an action form. The request is subject to a 10-second timeout if no response is received from the app server.

Body Params

Request to notify of an on change event.

expires_at

string

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

user

string

The user GID this hook is coming from.

workspace

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

changed_field

string

The name of the changed FormField.

action

string

The ID of an existing rule action that is being edited.

action_type

string

The ID of the configuration used to create the rule action.

project

string

The project GID this hook is coming from.

Responses

Language

URL

Response

Choose an example:

application/json

200Successfully returned the new state of the form.

400Something was wrong with the form data.

401Unauthorized

403Forbidden

404Not found

500Server error