ASasana
Rule actions

On action change callback

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. <br> <br> <a href="https://d3ki9tyy5l5ruj.cloudfront.net/obj/e17aad6e1b091b6fa410679d417d4c48643339ea/ac-rule-on-change.png"> <img src="https://d3ki9tyy5l5ruj.cloudfront.net/obj/e17aad6e1b091b6fa410679d417d4c48643339ea/ac-rule-on-change.png" alt="App components rule on change request flow"/> </a>

post/action.on_change_callback_path_placeholder

Request

  • Base URL
    {siteUrl}
  • URL
    {siteUrl}/action.on_change_callback_path_placeholder
  • Auth
    none declared

Request body

expires_atstring

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

userstring

The user GID this hook is coming from.

workspacestring

The workspace GID this hook is coming from.

valuesobject

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_fieldstring

The name of the changed FormField.

actionstring

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

action_typestring

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

projectstring

The project GID this hook is coming from.

Example request

{
  "expires_at": "2019-04-15T01:01:46.055Z",
  "user": "54321",
  "workspace": "12345",
  "values": {
    "checkbox_field_1": [
      "opt-in"
    ],
    "date_field_1": "2021-12-31T08:00:00.000Z",
    "datetime_field_1": "2023-01-01T00:00:00.000Z",
    "dropdown_field_1": "red",
    "multi_line_text_field_1": "Multiline Text",
    "radio_button_field_1": "blue",
    "rich_text_field_1": "<BODY>Rich Text</BODY>",
    "single_line_text_field_1": "Single Line Text",
    "static_text_field_1": "Static Text",
    "typeahead_field_1": {
      "icon_url": "https://example.com/icon.png",
      "subtitle": "Subtitle",
      "title": "Title",
      "value": "Typeahead"
    }
  },
  "changed_field": "checkbox_field_1",
  "action": "12345",
  "action_type": "45678",
  "project": "12345"
}

Response

Successfully returned the new state of the form.

template'form_metadata_v0' required

The interface name and version of a distinct form UI layout. A template is directly associated with a particular metadata schema.

Example response

{
  "template": "form_metadata_v0",
  "metadata": {
    "title": "Create New Issue",
    "on_submit_callback": "https://www.example.com/on_submit",
    "on_change_callback": "https://www.example.com/on_change"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.